@regulaforensics/document-reader-webclient 6.9.2 → 6.9.3

package/src/models/result.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.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 Result {
-    /**
-    * Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image
-    */
-    DOCUMENT_IMAGE = 1,
-    /**
-    * Contains MRZ OCR results
-    */
-    MRZ_TEXT = 3,
-    /**
-    * Contains raw information about barcodes on the input image
-    */
-    BARCODES = 5,
-    /**
-    * Contains cropped graphic fields from Visual zone
-    */
-    VISUAL_GRAPHICS = 6,
-    /**
-    * Contains list of document type candidates with their probabilities and descriptions
-    */
-    DOCUMENT_TYPE_CANDIDATES = 8,
-    /**
-    * Contains description of determined document type, if any
-    */
-    DOCUMENT_TYPE = 9,
-    /**
-    * Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)
-    */
-    LEXICAL_ANALYSIS = 15,
-    /**
-    * Contains Visual zone OCR results
-    */
-    VISUAL_TEXT = 17,
-    /**
-    * Contains barcode parsing result with text fields
-    */
-    BARCODE_TEXT = 18,
-    /**
-    * Contains barcode parsing result with graphic fields
-    */
-    BARCODE_GRAPHICS = 19,
-    /**
-    * Contains result of document authenticity checks
-    */
-    AUTHENTICITY = 20,
-    /**
-    * Contains image quality check results
-    */
-    IMAGE_QUALITY = 30,
-    /**
-    * Contains check statuses with details, grouped by source
-    */
-    STATUS = 33,
-    /**
-    * Contains result of portraits comparison
-    */
-    PORTRAIT_COMPARISON = 34,
-    /**
-    * Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks
-    */
-    TEXT = 36,
-    /**
-    * Contains images from all document sources (mrz, rfid, visual, barcode)
-    */
-    IMAGES = 37,
-    /**
-    * Contains result of fingerprints comparison
-    */
-    FINGERPRINT_COMPARISON = 39,
-    /**
-    * Contains encrypted ResultContainerList
-    */
-    ENCRYPTED_RCL = 49,
-    /**
-    * Contains license
-    */
-    LICENSE = 50,
-    /**
-    * Contains information about document position on the input image, its center, angle, etc
-    */
-    DOCUMENT_POSITION = 85,
-    /**
-    * Contains RFID raw data
-    */
-    RFID_RAW_DATA = 101,
-    /**
-    * Contains RFID text results
-    */
-    RFID_TEXT = 102,
-    /**
-    * Contains RFID graphic results
-    */
-    RFID_GRAPHICS = 103,
-    /**
-    * Contains RFID binary data
-    */
-    RFID_BINARY_DATA = 104,
-    /**
-    * Contains RFID original graphics data
-    */
-    RFID_ORIGINAL_GRAPHICS = 105
-}
-
-
-

package/src/models/rfid-location.ts

@@ -1,38 +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.
- */
-
-
-
-/**
- * Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document
- * @export
- * @enum {string}
- */
-export enum RfidLocation {
-    /**
-    * There is no RFID chip in the document
-    */
-    NONE = 0,
-    /**
-    * The RFID chip is located in the document data page
-    */
-    MAIN_PAGE = 1,
-    /**
-    * The RFID chip is located in the back page or inlay of the document
-    */
-    BACK_PAGE = 2
-}
-
-
-

package/src/models/rfid-origin.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.
- */
-
-
-
-/**
- * Location of data in RFID chip
- * @export
- * @interface RfidOrigin
- */
-export interface RfidOrigin {
-    /**
-     * Source data group file
-     * @type {number}
-     * @memberof RfidOrigin
-     */
-    dg: number;
-    /**
-     * Index of the source record of the image with biometric information in the information data group
-     * @type {number}
-     * @memberof RfidOrigin
-     */
-    dgTag?: number;
-    /**
-     * Index of the template in the record with biometric data
-     * @type {number}
-     * @memberof RfidOrigin
-     */
-    tagEntry?: number;
-    /**
-     * Index of the variant of the biometric data template
-     * @type {number}
-     * @memberof RfidOrigin
-     */
-    entryView?: number;
-}
-
-

package/src/models/rfid-text-data-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 { StatusResult } from './status-result';
-import { TextResult } from './text-result';
-import { VisualOcrExtendedResult } from './visual-ocr-extended-result';
-
-/**
- * @type RfidTextDataResult
- * Text fields extracted from document RFID chip
- * @export
- */
-export type RfidTextDataResult = MrzOcrExtendedResultAllOf & ResultItem;
-
-
-

package/src/models/scenario.ts

@@ -1,98 +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.
- */
-
-
-
-/**
- * Document processing scenario
- * @export
- * @enum {string}
- */
-export enum Scenario {
-    /**
-    * Processing scenario for obtaining MRZ data
-    */
-    MRZ = 'Mrz',
-    /**
-    * Processing scenario for obtaining barcode data
-    */
-    BARCODE = 'Barcode',
-    /**
-    * Processing scenario for detecting document boundaries
-    */
-    LOCATE = 'Locate',
-    /**
-    * Processing scenario for obtaining visual zone OCR results
-    */
-    OCR = 'Ocr',
-    /**
-    * Processing scenario for document type recognition
-    */
-    DOCTYPE = 'DocType',
-    /**
-    * Processing scenario for obtaining MRZ and/or barcode data
-    */
-    MRZ_OR_BARCODE = 'MrzOrBarcode',
-    /**
-    * Processing scenario for detecting document boundaries and/or obtaining MRZ data
-    */
-    MRZ_OR_LOCATE = 'MrzOrLocate',
-    /**
-    * Processing scenario for detecting document boundaries and obtaining MRZ data
-    */
-    MRZ_AND_LOCATE = 'MrzAndLocate',
-    /**
-    * Processing scenario for detecting the document boundaries and obtaining barcode data
-    */
-    BARCODE_AND_LOCATE = 'BarcodeAndLocate',
-    /**
-    * Processing scenario for obtaining MRZ data or visual zone OCR results
-    */
-    MRZ_OR_OCR = 'MrzOrOcr',
-    /**
-    * Processing scenario for obtaining MRZ or barcode or visual zone OCR results
-    */
-    MRZ_OR_BARCODE_OR_OCR = 'MrzOrBarcodeOrOcr',
-    /**
-    * Processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results
-    */
-    LOCATE_VISUAL_AND_MRZ_OR_OCR = 'LocateVisual_And_MrzOrOcr',
-    /**
-    * Processing scenario for obtaining all document data
-    */
-    FULL_PROCESS = 'FullProcess',
-    /**
-    * Processing scenario for obtaining all document data and document authentication
-    */
-    FULL_AUTH = 'FullAuth',
-    /**
-    * Processing scenario for obtaining data from registration stamps
-    */
-    RUS_STAMP = 'RusStamp',
-    /**
-    * Processing scenario for obtaining OCR results of any image
-    */
-    OCR_FREE = 'OcrFree',
-    /**
-    * Processing scenario for obtaining bank card data
-    */
-    CREDIT_CARD = 'CreditCard',
-    /**
-    * Scenario for obtaining an original image without any processing
-    */
-    CAPTURE = 'Capture'
-}
-
-
-

package/src/models/security-feature-result-all-of.ts

@@ -1,66 +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 { AreaContainer } from './area-container';
-import { Critical } from './critical';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { SecurityFeatureType } from './security-feature-type';
-import { Visibility } from './visibility';
-
-/**
- * 
- * @export
- * @interface SecurityFeatureResultAllOf
- */
-export interface SecurityFeatureResultAllOf {
-    /**
-     * 
-     * @type {SecurityFeatureType}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    ElementType?: SecurityFeatureType;
-    /**
-     * 
-     * @type {RectangleCoordinates}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    ElementRect?: RectangleCoordinates;
-    /**
-     * 
-     * @type {Visibility}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    Visibility?: Visibility;
-    /**
-     * 
-     * @type {Critical}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    CriticalFlag?: Critical;
-    /**
-     * 
-     * @type {AreaContainer}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    AreaList?: AreaContainer;
-    /**
-     * 
-     * @type {number}
-     * @memberof SecurityFeatureResultAllOf
-     */
-    Reserved2?: number;
-}
-
-

package/src/models/security-feature-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.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 { AreaContainer } from './area-container';
-import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
-import { CheckDiagnose } from './check-diagnose';
-import { CheckResult } from './check-result';
-import { Critical } from './critical';
-import { FiberResult } from './fiber-result';
-import { IdentResult } from './ident-result';
-import { OCRSecurityTextResult } from './ocrsecurity-text-result';
-import { PhotoIdentResult } from './photo-ident-result';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { SecurityFeatureResultAllOf } from './security-feature-result-all-of';
-import { SecurityFeatureType } from './security-feature-type';
-import { Visibility } from './visibility';
-
-/**
- * @type SecurityFeatureResult
- * @export
- */
-export type SecurityFeatureResult = AuthenticityCheckResultItem & SecurityFeatureResultAllOf;
-
-
-

package/src/models/security-feature-type.ts

@@ -1,206 +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 identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/
- * @export
- * @enum {string}
- */
-export enum SecurityFeatureType {
-    /**
-    * Blank element
-    */
-    BLANK = 0,
-    /**
-    * Personalization element
-    */
-    FILL = 1,
-    /**
-    * Photo
-    */
-    PHOTO = 2,
-    /**
-    * MRZ
-    */
-    MRZ = 3,
-    /**
-    * False luminescence
-    */
-    FALSE_LUMINESCENCE = 4,
-    /**
-    * Hologram (static)
-    */
-    HOLO_SIMPLE = 5,
-    /**
-    * Hologram (static verify)
-    */
-    HOLO_VERIFY_STATIC = 6,
-    /**
-    * Hologram (static verify multiple)
-    */
-    HOLO_VERIFY_MULTI_STATIC = 7,
-    /**
-    * Hologram (dynamic verify)
-    */
-    HOLO_VERIFY_DYNAMIC = 8,
-    /**
-    * Pattern (non-interrupted)
-    */
-    PATTERN_NOT_INTERRUPTED = 9,
-    /**
-    * Pattern (non-shifted)
-    */
-    PATTERN_NOT_SHIFTED = 10,
-    /**
-    * Pattern (same colors)
-    */
-    PATTERN_SAME_COLORS = 11,
-    /**
-    * Pattern (IR invisible)
-    */
-    PATTERN_IR_INVISIBLE = 12,
-    /**
-    * Photo size
-    */
-    PHOTO_SIZE_CHECK = 13,
-    /**
-    * Main vs ghost portrait comparison
-    */
-    PORTRAIT_COMPARISON_VS_GHOST = 14,
-    /**
-    * Main vs RFID portrait comparison
-    */
-    PORTRAIT_COMPARISON_VS_RFID = 15,
-    /**
-    * Main vs other page portrait comparison
-    */
-    PORTRAIT_COMPARISON_VS_VISUAL = 16,
-    /**
-    * Barcode
-    */
-    BARCODE = 17,
-    /**
-    * Pattern (different line thickness)
-    */
-    PATTERN_DIFFERENT_LINES_THICKNESS = 18,
-    /**
-    * Main vs live camera portrait comparison
-    */
-    PORTRAIT_COMPARISON_VS_CAMERA = 19,
-    /**
-    * RFID vs live camera portrait comparison
-    */
-    PORTRAIT_COMPARISON_RFID_VS_CAMERA = 20,
-    /**
-    * Ghost photo
-    */
-    GHOST_PHOTO = 21,
-    /**
-    * Clear ghost photo
-    */
-    CLEAR_GHOST_PHOTO = 22,
-    /**
-    * Invisible object
-    */
-    INVISIBLE_OBJECT = 23,
-    /**
-    * Low contrast object
-    */
-    LOW_CONTRAST_OBJECT = 24,
-    /**
-    * Photo color check
-    */
-    PHOTO_COLOR = 25,
-    /**
-    * Photo squareness
-    */
-    PHOTO_SHAPE = 26,
-    /**
-    * Photo corners shape
-    */
-    PHOTO_CORNERS = 27,
-    /**
-    * OCR
-    */
-    OCR = 28,
-    /**
-    * External vs main portrait comparison
-    */
-    PORTRAIT_COMPARISON_EXT_VS_VISUAL = 29,
-    /**
-    * External vs RFID portrait comparison
-    */
-    PORTRAIT_COMPARISON_EXT_VS_RFID = 30,
-    /**
-    * External vs live camera portrait comparison
-    */
-    PORTRAIT_COMPARISON_EXT_VS_CAMERA = 31,
-    /**
-    * Portrait Depth
-    */
-    LIVENESS_DEPTH = 32,
-    /**
-    * Micro text
-    */
-    MICRO_TEXT = 33,
-    /**
-    * Fluorescent Object
-    */
-    FLUORESCENT_OBJECT = 34,
-    /**
-    * Facial landmarks check
-    */
-    LANDMARK_CHECK = 35,
-    /**
-    * Facial image presence
-    */
-    FACE_PRESENCE = 36,
-    /**
-    * Facial image absence
-    */
-    FACE_ABSENCE = 38,
-    /**
-    * Liveness screen capture
-    */
-    LIVENESS_SCREEN_CAPTURE = 39,
-    /**
-    * Liveness electronic device
-    */
-    LIVENESS_ELECTRONIC_DEVICE = 40,
-    /**
-    * Liveness OVI
-    */
-    LIVENESS_OVI = 41,
-    /**
-    * Barcode size check
-    */
-    BARCODE_SIZE_CHECK = 42,
-    /**
-    * LASINK
-    */
-    LASINK = 43,
-    /**
-    * Liveness MLI
-    */
-    LIVENESS_MLI = 44,
-    /**
-    * Liveness barcode background
-    */
-    LIVENESS_BARCODE_BACKGROUND = 45
-}
-
-
-

package/src/models/source-validity.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.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 { Source } from './source';
-
-/**
- * 
- * @export
- * @interface SourceValidity
- */
-export interface SourceValidity {
-    /**
-     * 
-     * @type {Source}
-     * @memberof SourceValidity
-     */
-    source: Source;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof SourceValidity
-     */
-    status: CheckResult;
-}
-
-