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

package/src/models/process-response.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.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 { ContainerList } from './container-list';
-import { ProcessingStatus } from './processing-status';
-import { RfidLocation } from './rfid-location';
-import { TransactionInfo } from './transaction-info';
-
-/**
- * 
- * @export
- * @interface ProcessResponse
- */
-export interface ProcessResponse {
-    /**
-     * 
-     * @type {RfidLocation}
-     * @memberof ProcessResponse
-     */
-    ChipPage?: RfidLocation;
-    /**
-     * 
-     * @type {ProcessingStatus}
-     * @memberof ProcessResponse
-     */
-    ProcessingFinished: ProcessingStatus;
-    /**
-     * 
-     * @type {ContainerList}
-     * @memberof ProcessResponse
-     */
-    ContainerList: ContainerList;
-    /**
-     * 
-     * @type {TransactionInfo}
-     * @memberof ProcessResponse
-     */
-    TransactionInfo: TransactionInfo;
-    /**
-     * Base64 encoded transaction processing log
-     * @type {string}
-     * @memberof ProcessResponse
-     */
-    log?: string;
-    /**
-     * Free-form object provided in request. See passBackObject property of ProcessRequest.
-     * @type {{ [key: string]: object; }}
-     * @memberof ProcessResponse
-     */
-    passBackObject?: { [key: string]: object; };
-    /**
-     * 
-     * @type {number}
-     * @memberof ProcessResponse
-     */
-    morePagesAvailable?: number;
-    /**
-     * Time the document processing has taken, ms.
-     * @type {number}
-     * @memberof ProcessResponse
-     */
-    elapsedTime?: number;
-}
-
-

package/src/models/process-system-info.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.
- */
-
-
-
-/**
- * 
- * @export
- * @interface ProcessSystemInfo
- */
-export interface ProcessSystemInfo {
-    /**
-     * Base64 encoded license file
-     * @type {string}
-     * @memberof ProcessSystemInfo
-     */
-    license?: string;
-    /**
-     * For internal use. Demo-sites recaptcha token.
-     * @type {string}
-     * @memberof ProcessSystemInfo
-     */
-    recaptcha_token?: string;
-}
-
-

package/src/models/processing-status.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.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 ProcessingStatus {
-    /**
-    * Processing was not finished
-    */
-    NOT_FINISHED = 0,
-    /**
-    * Processing finished
-    */
-    FINISHED = 1,
-    /**
-    * Processing finished by timeout
-    */
-    TIMEOUT = 2
-}
-
-
-

package/src/models/raw-image-container-list.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.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 { ImageData } from './image-data';
-
-/**
- * 
- * @export
- * @interface RawImageContainerList
- */
-export interface RawImageContainerList {
-    /**
-     * 
-     * @type {number}
-     * @memberof RawImageContainerList
-     */
-    Count?: number;
-    /**
-     * 
-     * @type {Array<ImageData>}
-     * @memberof RawImageContainerList
-     */
-    Images?: Array<ImageData>;
-}
-
-

package/src/models/raw-image-container.ts

@@ -1,37 +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.
- */
-
-
-
-/**
- * 
- * @export
- * @interface RawImageContainer
- */
-export interface RawImageContainer {
-    /**
-     * 
-     * @type {string}
-     * @memberof RawImageContainer
-     */
-    format?: string;
-    /**
-     * base64 encoded image
-     * @type {string}
-     * @memberof RawImageContainer
-     */
-    image?: string;
-}
-
-

package/src/models/raw-image-result-all-of.ts

@@ -1,32 +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 { ImageData } from './image-data';
-
-/**
- * Returns cropped and rotated image of document. Most of coordinates in other types defined on that image
- * @export
- * @interface RawImageResultAllOf
- */
-export interface RawImageResultAllOf {
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof RawImageResultAllOf
-     */
-    RawImageContainer: ImageData;
-}
-
-

package/src/models/raw-image-result.ts

@@ -1,34 +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 { ChosenDocumentTypeResult } from './chosen-document-type-result';
-import { DocumentTypesCandidatesResult } from './document-types-candidates-result';
-import { GraphicsResult } from './graphics-result';
-import { ImageData } from './image-data';
-import { LexicalAnalysisResult } from './lexical-analysis-result';
-import { RawImageResultAllOf } from './raw-image-result-all-of';
-import { ResultItem } from './result-item';
-import { StatusResult } from './status-result';
-import { TextDataResult } from './text-data-result';
-import { TextResult } from './text-result';
-
-/**
- * @type RawImageResult
- * @export
- */
-export type RawImageResult = RawImageResultAllOf & ResultItem;
-
-
-

package/src/models/rectangle-coordinates.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.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.
- */
-
-
-
-/**
- * Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)
- * @export
- * @interface RectangleCoordinates
- */
-export interface RectangleCoordinates {
-    /**
-     * 
-     * @type {number}
-     * @memberof RectangleCoordinates
-     */
-    left: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof RectangleCoordinates
-     */
-    top: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof RectangleCoordinates
-     */
-    right: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof RectangleCoordinates
-     */
-    bottom: number;
-}
-
-

package/src/models/result-item.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 { 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 { StatusResult } from './status-result';
-import { TextDataResult } from './text-data-result';
-import { TextResult } from './text-result';
-
-/**
- * Common fields for all result objects
- * @export
- * @interface ResultItem
- */
-export interface ResultItem {
-    /**
-     * 
-     * @type {number}
-     * @memberof ResultItem
-     */
-    buf_length?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ResultItem
-     */
-    light?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ResultItem
-     */
-    list_idx?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ResultItem
-     */
-    page_idx?: number;
-    /**
-     * Same as Result type, but used for safe parsing of not-described values. See Result type.
-     * @type {number}
-     * @memberof ResultItem
-     */
-    result_type: number;
-}
-
-

package/src/models/result.ts

@@ -1,106 +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.
- */
-
-
-
-/**
- * Describes possible extracted result types from documents
- * @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 image quality check results
-    */
-    IMAGE_QUALITY = 30,
-    /**
-    * Contains check statuses with details, grouped by source
-    */
-    STATUS = 33,
-    /**
-    * 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 MRZ OCR results
-    */
-    MRZ_TEXT = 3,
-    /**
-    * Contains Visual zone OCR results
-    */
-    VISUAL_TEXT = 17,
-    /**
-    * Contains barcode parsing result with text fields
-    */
-    BARCODE_TEXT = 18,
-    /**
-    * Contains RFID parsing result with text fields
-    */
-    RFID_TEXT = 102,
-    /**
-    * 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 cropped graphic fields from Visual zone
-    */
-    VISUAL_GRAPHICS = 6,
-    /**
-    * Contains barcode parsing result with graphic fields
-    */
-    BARCODE_GRAPHICS = 19,
-    /**
-    * Contains RFID parsing result with graphic fields
-    */
-    RFID_GRAPHICS = 103,
-    /**
-    * 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 result of document authenticity checks
-    */
-    AUTHENTICITY = 20,
-    /**
-    * Contains information about document position on the input image, its center, angle, etc
-    */
-    DOCUMENT_POSITION = 85,
-    /**
-    * Contains raw information about barcodes on the input image
-    */
-    BARCODES = 5,
-    /**
-    * Contains license
-    */
-    LICENSE = 50,
-    /**
-    * Contains encrypted ResultContainerList
-    */
-    ENCRYPTED_RCL = 49
-}
-
-
-

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.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.
- */
-
-
-
-/**
- * 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.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.
- */
-
-
-
-/**
- * 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;
-
-
-