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

package/src/models/chosen-document-type-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.6.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 { ChosenDocumentTypeResultAllOf } from './chosen-document-type-result-all-of';
-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 { OneCandidate } from './one-candidate';
-import { ResultItem } from './result-item';
-import { StatusResult } from './status-result';
-import { TextDataResult } from './text-data-result';
-import { TextResult } from './text-result';
-
-/**
- * @type ChosenDocumentTypeResult
- * Contains information about the type of document that was determined based on the analysis of the provided image
- * @export
- */
-export type ChosenDocumentTypeResult = ChosenDocumentTypeResultAllOf & ResultItem;
-
-
-

package/src/models/chosen-document-type.ts

@@ -1,81 +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.6.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 { FDSIDList } from './fdsidlist';
-import { RfidLocation } from './rfid-location';
-
-/**
- * Contains information about one document type candidate
- * @export
- * @interface ChosenDocumentType
- */
-export interface ChosenDocumentType {
-    /**
-     * Document name
-     * @type {string}
-     * @memberof ChosenDocumentType
-     */
-    DocumentName?: string;
-    /**
-     * Unique document type template identifier (Regula\'s internal numeric code)
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    ID?: number;
-    /**
-     * A measure of the likelihood of correct recognition in the analysis of this type of document
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    P?: number;
-    /**
-     * 
-     * @type {RfidLocation}
-     * @memberof ChosenDocumentType
-     */
-    RFID_Presence?: RfidLocation;
-    /**
-     * 
-     * @type {FDSIDList}
-     * @memberof ChosenDocumentType
-     */
-    FDSIDList?: FDSIDList;
-    /**
-     * Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    NecessaryLights?: number;
-    /**
-     * Set of authentication options provided for this type of document (combination of Authenticity enum)
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    CheckAuthenticity?: number;
-    /**
-     * The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    UVExp?: number;
-    /**
-     * Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity
-     * @type {number}
-     * @memberof ChosenDocumentType
-     */
-    AuthenticityNecessaryLights?: number;
-}
-
-

package/src/models/container-list.ts

@@ -1,52 +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.6.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';
-
-/**
- * List with various objects, containing processing results
- * @export
- * @interface ContainerList
- */
-export interface ContainerList {
-    /**
-     * Length of list (Count for items)
-     * @type {number}
-     * @memberof ContainerList
-     */
-    Count?: number;
-    /**
-     * 
-     * @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>}
-     * @memberof ContainerList
-     */
-    List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>;
-}
-
-

package/src/models/critical.ts

@@ -1,34 +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.6.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 the criticality of the security element
- * @export
- * @enum {string}
- */
-export enum Critical {
-    /**
-    * Security element may be absent in a valid document
-    */
-    NOT_CRITICAL = 0,
-    /**
-    * Security element must be present in a valid document
-    */
-    CRITICAL = 1
-}
-
-
-

package/src/models/cross-source-value-comparison.ts

@@ -1,45 +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.6.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 CrossSourceValueComparison
- */
-export interface CrossSourceValueComparison {
-    /**
-     * 
-     * @type {Source}
-     * @memberof CrossSourceValueComparison
-     */
-    sourceLeft: Source;
-    /**
-     * 
-     * @type {Source}
-     * @memberof CrossSourceValueComparison
-     */
-    sourceRight: Source;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof CrossSourceValueComparison
-     */
-    status: CheckResult;
-}
-
-

package/src/models/data-module.ts

@@ -1,55 +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.6.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 DataModule
- */
-export interface DataModule {
-    /**
-     * 
-     * @type {string}
-     * @memberof DataModule
-     */
-    mData?: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof DataModule
-     */
-    mLength?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof DataModule
-     */
-    mReserved1?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof DataModule
-     */
-    mReserver2?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof DataModule
-     */
-    mType?: number;
-}
-
-

package/src/models/details-optical.ts

@@ -1,74 +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.6.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';
-
-/**
- * 
- * @export
- * @interface DetailsOptical
- */
-export interface DetailsOptical {
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    overallStatus: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    docType: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    expiry: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    imageQA: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    mrz: CheckResult;
-    /**
-     * Number of processed pages in the document
-     * @type {number}
-     * @memberof DetailsOptical
-     */
-    pagesCount: number;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    security: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsOptical
-     */
-    text: CheckResult;
-}
-
-

package/src/models/details-rfid.ts

@@ -1,68 +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.6.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';
-
-/**
- * 
- * @export
- * @interface DetailsRFID
- */
-export interface DetailsRFID {
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    overallStatus: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    AA: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    BAC: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    CA: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    PA: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    PACE: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof DetailsRFID
-     */
-    TA: CheckResult;
-}
-
-

package/src/models/device-info.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.6.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;
-}
-
-

package/src/models/doc-bar-code-info-all-of.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.6.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 { PArrayField } from './parray-field';
-
-/**
- * 
- * @export
- * @interface DocBarCodeInfoAllOf
- */
-export interface DocBarCodeInfoAllOf {
-    /**
-     * Count of array fields
-     * @type {number}
-     * @memberof DocBarCodeInfoAllOf
-     */
-    nFields?: number;
-    /**
-     * Data from barcode
-     * @type {Array<PArrayField>}
-     * @memberof DocBarCodeInfoAllOf
-     */
-    pArrayFields?: Array<PArrayField>;
-}
-
-

package/src/models/doc-bar-code-info.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.6.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 { DocBarCodeInfoAllOf } from './doc-bar-code-info-all-of';
-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 { PArrayField } from './parray-field';
-import { ResultItem } from './result-item';
-import { StatusResult } from './status-result';
-import { TextDataResult } from './text-data-result';
-import { TextResult } from './text-result';
-
-/**
- * @type DocBarCodeInfo
- * Raw data from BarCodes
- * @export
- */
-export type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
-
-
-

package/src/models/doc-visual-extended-field.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.6.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 { RectangleCoordinates } from './rectangle-coordinates';
-import { StringRecognitionResult } from './string-recognition-result';
-import { TextFieldType } from './text-field-type';
-
-/**
- * 
- * @export
- * @interface DocVisualExtendedField
- */
-export interface DocVisualExtendedField {
-    /**
-     * 
-     * @type {TextFieldType}
-     * @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}
-     * @memberof DocVisualExtendedField
-     */
-    wLCID: LCID;
-    /**
-     * Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.
-     * @type {Array<StringRecognitionResult>}
-     * @memberof DocVisualExtendedField
-     */
-    StringsResult?: Array<StringRecognitionResult>;
-    /**
-     * Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by \'^\'
-     * @type {string}
-     * @memberof DocVisualExtendedField
-     */
-    Buf_Text?: string;
-    /**
-     * 
-     * @type {RectangleCoordinates}
-     * @memberof DocVisualExtendedField
-     */
-    FieldRect?: RectangleCoordinates;
-    /**
-     * Origin data group information. Only for Result.RFID_TEXT results.
-     * @type {number}
-     * @memberof DocVisualExtendedField
-     */
-    RFID_OriginDG?: number;
-    /**
-     * Index of the text field record in origin data group. Only for Result.RFID_TEXT results.
-     * @type {number}
-     * @memberof DocVisualExtendedField
-     */
-    RFID_OriginTagEntry?: number;
-}
-
-