@regulaforensics/document-reader-webclient
Version:
Regula Document Reader js client for the browser and node.js based on axios
2,154 lines (2,106 loc) • 378 kB
TypeScript
import { AxiosInstance } from 'axios';
import { AxiosResponse } from 'axios';
/**
*
* @export
* @interface AreaArray
*/
export declare interface AreaArray {
/**
* Number of elements in List and Points
* @type {number}
* @memberof AreaArray
*/
'Count': number;
/**
*
* @type {Array<RectangleCoordinates>}
* @memberof AreaArray
*/
'List': Array<RectangleCoordinates>;
/**
*
* @type {Array<PointArray>}
* @memberof AreaArray
*/
'Points': Array<PointArray>;
}
/**
* Checked fragment coordinates
* @export
* @interface AreaContainer
*/
export declare interface AreaContainer {
/**
*
* @type {number}
* @memberof AreaContainer
*/
'Count': number;
/**
*
* @type {Array<RectangleCoordinates>}
* @memberof AreaContainer
*/
'List': Array<RectangleCoordinates>;
/**
*
* @type {Array<PointsContainer>}
* @memberof AreaContainer
*/
'Points': Array<PointsContainer>;
}
export declare class Authenticity implements AuthenticityCheckList {
List: Array<AuthenticityCheckResult>;
page_idx: number;
Count: number;
constructor(origin: AuthenticityCheckList, page_idx: number);
uvLuminescenceChecks(): SecurityFeatureChecks | undefined;
irB900Checks(): SecurityFeatureChecks | undefined;
imagePatternChecks(): IdentChecks | undefined;
axialProtectionChecks(): SecurityFeatureChecks | undefined;
uvFiberChecks(): FiberChecks | undefined;
irVisibilityChecks(): IdentChecks | undefined;
ocrSecurityTextChecks(): OCRSecurityTextChecks | undefined;
ipiChecks(): ImageIdentChecks | undefined;
embedImageChecks(): SecurityFeatureChecks | undefined;
hologramsChecks(): SecurityFeatureChecks | undefined;
imageAreaChecks(): SecurityFeatureChecks | undefined;
portraitComparisonChecks(): IdentChecks | undefined;
barcodeFormatCheckChecks(): SecurityFeatureChecks | undefined;
kinegramChecks(): IdentChecks | undefined;
letterScreenChecks(): IdentChecks | undefined;
hologramDetectionChecks(): IdentChecks | undefined;
mrzChecks(): SecurityFeatureChecks | undefined;
livenessChecks(): IdentChecks | undefined;
resultByType(authenticityType: number): AuthenticityCheckResult | undefined;
private fiberOrUndefined;
private identOrUndefined;
private imageIdentOrUndefined;
private ocrSecurityTextOrUndefined;
private securityFeatureOrUndefined;
}
/**
*
* @export
* @interface AuthenticityCheckList
*/
export declare interface AuthenticityCheckList {
/**
* Count of items in List
* @type {number}
* @memberof AuthenticityCheckList
*/
'Count': number;
/**
* Authenticity Check
* @type {Array<AuthenticityCheckResult>}
* @memberof AuthenticityCheckList
*/
'List': Array<AuthenticityCheckResult>;
}
/**
*
* @export
* @interface AuthenticityCheckListItem
*/
export declare interface AuthenticityCheckListItem {
/**
*
* @type {AuthenticityCheckList}
* @memberof AuthenticityCheckListItem
*/
'AuthenticityCheckList': AuthenticityCheckList;
}
/**
*
* @export
* @interface AuthenticityCheckResult
*/
export declare interface AuthenticityCheckResult {
/**
*
* @type {AuthenticityResultType}
* @memberof AuthenticityCheckResult
*/
'Type': AuthenticityResultType;
/**
*
* @type {CheckResult}
* @memberof AuthenticityCheckResult
*/
'Result': CheckResult;
/**
* Count of items in List
* @type {number}
* @memberof AuthenticityCheckResult
*/
'Count'?: number;
/**
*
* @type {Array<AuthenticityCheckResultListInner>}
* @memberof AuthenticityCheckResult
*/
'List': Array<AuthenticityCheckResultListInner>;
}
/**
* Common fields for all authenticity result objects
* @export
* @interface AuthenticityCheckResultItem
*/
export declare interface AuthenticityCheckResultItem {
/**
*
* @type {AuthenticityResultType}
* @memberof AuthenticityCheckResultItem
*/
'Type': AuthenticityResultType;
/**
*
* @type {CheckResult}
* @memberof AuthenticityCheckResultItem
*/
'ElementResult'?: CheckResult;
/**
*
* @type {CheckDiagnose}
* @memberof AuthenticityCheckResultItem
*/
'ElementDiagnose'?: CheckDiagnose;
/**
*
* @type {number}
* @memberof AuthenticityCheckResultItem
*/
'PercentValue'?: number;
}
/**
* @type AuthenticityCheckResultListInner
* @export
*/
export declare type AuthenticityCheckResultListInner = FiberResult | IdentResult | OCRSecurityTextResult | PhotoIdentResult | SecurityFeatureResult;
/**
* @type AuthenticityResult
* @export
*/
export declare type AuthenticityResult = AuthenticityCheckListItem & ResultItem;
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.
* @export
* @enum {number}
*/
export declare enum AuthenticityResultType {
/**
* Document luminescence check in UV light
*/
UV_LUMINESCENCE = 1,
/**
* B900 ink MRZ contrast check in IR light
*/
IR_B900 = 2,
/**
* Image patterns presence/absence check (position, shape, color)
*/
IMAGE_PATTERN = 4,
/**
* Confirm laminate integrity check in axial light
*/
AXIAL_PROTECTION = 8,
/**
* Protection fibers presence check (color, density) in UV light
*/
UV_FIBERS = 16,
/**
* Document elements visibility check in IR light
*/
IR_VISIBILITY = 32,
/**
* OCR for the text field in UV light comparison with other text sources check
*/
OCR_SECURITY_TEXT = 64,
/**
* Invisible Personal Information (IPI) visualization
*/
IPI = 128,
/**
* Owner's photo embedding check (is photo printed or sticked)
*/
PHOTO_EMBED_TYPE = 512,
/**
* OVI check. Deprecated, use Document liveness check instead
*/
OVI = 1024,
/**
* Hologram presence check. Deprecated
*/
HOLOGRAMS = 4096,
/**
* Owner's photo area advanced check (photo shape, size, position, etc.)
*/
PHOTO_AREA = 8192,
/**
* Portrait comparison check (document printed vs chip vs live)
*/
PORTRAIT_COMPARISON = 32768,
/**
* Barcode format check (code metadata, data format, contents format, etc.)
*/
BARCODE_FORMAT_CHECK = 65536,
/**
* Kinegram check
*/
KINEGRAM = 131072,
/**
* LetterScreen check
*/
LETTER_SCREEN = 262144,
/**
* Hologram detection and validation check
*/
HOLOGRAM_DETECTION = 524288,
/**
* Fingerprint comparison check
*/
FINGERPRINT_COMPARISON = 1048576,
/**
* Document liveness check
*/
LIVENESS = 2097152,
/**
* Extended OCR Check
*/
EXTENDED_OCR_CHECK = 4194304,
/**
* Extended MRZ check
*/
EXTENDED_MRZ_CHECK = 8388608,
/**
* Encrypted IPI
*/
ENCRYPTED_IPI = 16777216
}
/**
*
* @export
* @interface AuthParams
*/
export declare interface AuthParams {
/**
* This parameter is used to enable document liveness check
* @type {boolean}
* @memberof AuthParams
*/
'checkLiveness'?: boolean;
/**
*
* @type {LivenessParams}
* @memberof AuthParams
*/
'livenessParams'?: LivenessParams;
/**
* This parameter is used to enable Document luminescence check in UV light
* @type {boolean}
* @memberof AuthParams
*/
'checkUVLuminiscence'?: boolean;
/**
* This parameter is used to enable B900 ink MRZ contrast check in IR light
* @type {boolean}
* @memberof AuthParams
*/
'checkIRB900'?: boolean;
/**
* This parameter is used to enable Image patterns presence/absence check (position, shape, color)
* @type {boolean}
* @memberof AuthParams
*/
'checkImagePatterns'?: boolean;
/**
* This parameter is used to enable Fibers detection
* @type {boolean}
* @memberof AuthParams
*/
'checkFibers'?: boolean;
/**
* This parameter is used to enable Extended MRZ Check
* @type {boolean}
* @memberof AuthParams
*/
'checkExtMRZ'?: boolean;
/**
* This parameter is used to enable Extended OCR Check
* @type {boolean}
* @memberof AuthParams
*/
'checkExtOCR'?: boolean;
/**
* This parameter is used to enable laminate integrity check in axial light
* @type {boolean}
* @memberof AuthParams
*/
'checkAxial'?: boolean;
/**
* This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)
* @type {boolean}
* @memberof AuthParams
*/
'checkBarcodeFormat'?: boolean;
/**
* This parameter is used to enable Document elements visibility check in IR light
* @type {boolean}
* @memberof AuthParams
*/
'checkIRVisibility'?: boolean;
/**
* This parameter is used to enable Invisible Personal Information (IPI) check
* @type {boolean}
* @memberof AuthParams
*/
'checkIPI'?: boolean;
/**
* This parameter is used to enable Owner\'s photo embedding check (is photo printed or sticked)
* @type {boolean}
* @memberof AuthParams
*/
'checkPhotoEmbedding'?: boolean;
/**
* This parameter is used to enable Portrait comparison check
* @type {boolean}
* @memberof AuthParams
*/
'checkPhotoComparison'?: boolean;
/**
* This parameter is used to enable LetterScreen check
* @type {boolean}
* @memberof AuthParams
*/
'checkLetterScreen'?: boolean;
/**
* This parameter is used to enable Security text check
* @type {boolean}
* @memberof AuthParams
*/
'checkSecurityText'?: boolean;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @enum {number}
*/
export declare enum BarCodeModuleType {
/**
* Module contains text data
*/
TEXT = 0,
/**
* Module contains byte data
*/
BYTE = 1,
/**
* Module contains numeric data
*/
NUM = 2,
/**
* Shifts in byte compaction mode (for PDF417)
*/
SHIFT = 3,
/**
* Module contains any data
*/
ALL = 4
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Enumeration contains the types of barcodes that can be processed
* @export
* @enum {number}
*/
export declare enum BarcodeType {
/**
* Unknown
*/
UNKNOWN = 0,
/**
* Code 128
*/
CODE128 = 1,
/**
* Code 39
*/
CODE39 = 2,
/**
* EAN-8
*/
EAN8 = 3,
/**
* ITF
*/
ITF = 4,
/**
* PDF417
*/
PDF417 = 5,
/**
* STF
*/
STF = 6,
/**
* MTF
*/
MTF = 7,
/**
* IATA
*/
IATA = 8,
/**
* Codabar
*/
CODABAR = 9,
/**
* UPC-A
*/
UPCA = 10,
/**
* Code 93
*/
CODE93 = 11,
/**
* UPC-E
*/
UPCE = 12,
/**
* EAN-13
*/
EAN13 = 13,
/**
* QR code
*/
QRCODE = 14,
/**
* Aztec code
*/
AZTEC = 15,
/**
* Datamatrix
*/
DATAMATRIX = 16,
/**
* All 1D barcodes
*/
ALL_1D = 17,
/**
* Code 11
*/
CODE11 = 18,
/**
* JAB code
*/
JABCODE = 19
}
export declare type Base64String = string;
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @interface BcPDF417INFO
*/
export declare interface BcPDF417INFO {
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'Angle': number;
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'bcColumn': number;
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'bcErrorLevel': number;
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'bcRow': number;
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'minX': number;
/**
*
* @type {number}
* @memberof BcPDF417INFO
*/
'minY': number;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @interface BcROIDETECT
*/
export declare interface BcROIDETECT {
/**
*
* @type {number}
* @memberof BcROIDETECT
*/
'bottom': number;
/**
*
* @type {number}
* @memberof BcROIDETECT
*/
'left': number;
/**
*
* @type {number}
* @memberof BcROIDETECT
*/
'right': number;
/**
*
* @type {number}
* @memberof BcROIDETECT
*/
'top': number;
}
/**
* Structure is used for storing the results of one bar-code module reading.
* @export
* @interface BinaryData
*/
export declare interface BinaryData {
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_Authentication_Info'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_MIFARE_Data_Validity'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_MIFARE_Data'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_EF_COM'?: {
[key: string]: any;
};
/**
*
* @type {RfidDG1}
* @memberof BinaryData
*/
'RFID_DG1'?: RfidDG1;
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG2'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG3'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG4'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG5'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG6'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG7'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG8'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG9'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG10'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG11'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG12'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG13'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG14'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG15'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_DG16'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'RFID_EF_SOD'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG1'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG2'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG3'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG4'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG5'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG6'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG7'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG8'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG9'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG10'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG11'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG12'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG13'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG14'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG15'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG16'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG17'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG18'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG19'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG20'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eID_DG21'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_COM'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_SOD'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG1'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG2'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG3'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG4'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG5'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG6'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG7'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG8'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG9'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG10'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG11'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG12'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG13'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'eDL_DG14'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'Visible_Digital_Seal'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'Visible_Digital_Seal_NC'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: any; }}
* @memberof BinaryData
*/
'Digital_Signature'?: {
[key: string]: any;
};
/**
*
* @type {RfidSessionData}
* @memberof BinaryData
*/
'RFID_Session_Data'?: RfidSessionData;
/**
*
* @type {DetailsRFID}
* @memberof BinaryData
*/
'RFID_Session_Data_Status'?: DetailsRFID;
/**
* Indexes of groups that aren\'t read
* @type {Array<RfidDataFileType>}
* @memberof BinaryData
*/
'RFID_ePassp_Directory'?: Array<RfidDataFileType>;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @interface ByteArrayItem
*/
export declare interface ByteArrayItem {
/**
* Byte array in base64
* @type {string}
* @memberof ByteArrayItem
*/
'ByteArray': string;
}
/**
* @type ByteArrayResult
* @export
*/
export declare type ByteArrayResult = ByteArrayItem & ResultItem;
/**
*
* @export
* @interface CandidatesListItem
*/
export declare interface CandidatesListItem {
/**
*
* @type {DocumentTypesCandidatesList}
* @memberof CandidatesListItem
*/
'CandidatesList'?: DocumentTypesCandidatesList;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @interface CertificateData
*/
export declare interface CertificateData {
/**
*
* @type {string}
* @memberof CertificateData
*/
'Data': string;
/**
*
* @type {number}
* @memberof CertificateData
*/
'Length': number;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/
* @export
* @enum {number}
*/
export declare enum CheckDiagnose {
UNKNOWN = 0,
PASS = 1,
INVALID_INPUT_DATA = 2,
INTERNAL_ERROR = 3,
EXCEPTION_IN_MODULE = 4,
UNCERTAIN_VERIFICATION = 5,
NECESSARY_IMAGE_NOT_FOUND = 7,
PHOTO_SIDES_NOT_FOUND = 8,
INVALID_CHECKSUM = 10,
SYNTAX_ERROR = 11,
LOGIC_ERROR = 12,
SOURCES_COMPARISON_ERROR = 13,
FIELDS_COMPARISON_LOGIC_ERROR = 14,
INVALID_FIELD_FORMAT = 15,
TRUE_LUMINESCENCE_ERROR = 20,
FALSE_LUMINESCENCE_ERROR = 21,
FIXED_PATTERN_ERROR = 22,
LOW_CONTRAST_IN_IR_LIGHT = 23,
INCORRECT_BACKGROUND_LIGHT = 24,
BACKGROUND_COMPARISON_ERROR = 25,
INCORRECT_TEXT_COLOR = 26,
PHOTO_FALSE_LUMINESCENCE = 27,
TOO_MUCH_SHIFT = 28,
CONTACT_CHIP_TYPE_MISMATCH = 29,
FIBERS_NOT_FOUND = 30,
TOO_MANY_OBJECTS = 31,
SPECKS_IN_UV = 33,
TOO_LOW_RESOLUTION = 34,
INVISIBLE_ELEMENT_PRESENT = 40,
VISIBLE_ELEMENT_ABSENT = 41,
ELEMENT_SHOULD_BE_COLORED = 42,
ELEMENT_SHOULD_BE_GRAYSCALE = 43,
PHOTO_WHITE_IR_DONT_MATCH = 44,
UV_DULL_PAPER_MRZ = 50,
FALSE_LUMINESCENCE_IN_MRZ = 51,
UV_DULL_PAPER_PHOTO = 52,
UV_DULL_PAPER_BLANK = 53,
UV_DULL_PAPER_ERROR = 54,
FALSE_LUMINESCENCE_IN_BLANK = 55,
BAD_AREA_IN_AXIAL = 60,
FALSE_IPI_PARAMETERS = 65,
ENCRYPTED_IPI_NOT_FOUND = 66,
ENCRYPTED_IPI_DATA_DONT_MATCH = 67,
FIELD_POS_CORRECTOR_HIGHLIGHT_IR = 80,
FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA = 81,
FIELD_POS_CORRECTOR_PHOTO_REPLACED = 82,
FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR = 83,
FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84,
FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85,
FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86,
OVI_IR_INVISIBLE = 90,
OVI_INSUFFICIENT_AREA = 91,
OVI_COLOR_INVARIABLE = 92,
OVI_BAD_COLOR_FRONT = 93,
OVI_BAD_COLOR_SIDE = 94,
OVI_WIDE_COLOR_SPREAD = 95,
OVI_BAD_COLOR_PERCENT = 96,
HOLOGRAM_ELEMENT_ABSENT = 100,
HOLOGRAM_SIDE_TOP_IMAGES_ABSENT = 101,
HOLOGRAM_ELEMENT_PRESENT = 102,
HOLOGRAM_FRAMES_IS_ABSENT = 103,
HOLOGRAM_HOLO_FIELD_IS_ABSENT = 104,
PHOTO_PATTERN_INTERRUPTED = 110,
PHOTO_PATTERN_SHIFTED = 111,
PHOTO_PATTERN_DIFFERENT_COLORS = 112,
PHOTO_PATTERN_IR_VISIBLE = 113,
PHOTO_PATTERN_NOT_INTERSECT = 114,
PHOTO_SIZE_IS_WRONG = 115,
PHOTO_PATTERN_INVALID_COLOR = 116,
PHOTO_PATTERN_SHIFTED_VERT = 117,
PHOTO_PATTERN_PATTERN_NOT_FOUND = 118,
PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS = 119,
PHOTO_IS_NOT_RECTANGLE = 120,
PHOTO_CORNERS_IS_WRONG = 121,
DOCUMENT_IS_CANCELLING = 122,
TEXT_COLOR_SHOULD_BE_BLUE = 130,
TEXT_COLOR_SHOULD_BE_GREEN = 131,
TEXT_COLOR_SHOULD_BE_RED = 132,
TEXT_SHOULD_BE_BLACK = 133,
BARCODE_WAS_READ_WITH_ERRORS = 140,
BARCODE_DATA_FORMAT_ERROR = 141,
BARCODE_SIZE_PARAMS_ERROR = 142,
NOT_ALL_BARCODES_READ = 143,
GLARES_IN_BARCODE_AREA = 144,
NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK = 145,
PORTRAIT_COMPARISON_PORTRAITS_DIFFER = 150,
PORTRAIT_COMPARISON_NO_SERVICE_REPLY = 151,
PORTRAIT_COMPARISON_SERVICE_ERROR = 152,
PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES = 153,
PORTRAIT_COMPARISON_NO_LIVE_PHOTO = 154,
PORTRAIT_COMPARISON_NO_SERVICE_LICENSE = 155,
PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED = 156,
MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS = 160,
MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE = 161,
FINGERPRINTS_COMPARISON_MISMATCH = 170,
HOLO_PHOTO_FACE_NOT_DETECTED = 180,
HOLO_PHOTO_FACE_COMPARISON_FAILED = 181,
HOLO_PHOTO_GLARE_IN_CENTER_ABSENT = 182,
HOLO_PHOTO_HOLO_ELEMENT_SHAPE_ERROR = 183,
HOLO_PHOTO_ALGORITHMS_STEPS_ERROR = 184,
HOLO_PHOTO_HOLO_AREAS_NOT_LOADED = 185,
HOLO_PHOTO_FINISHED_BY_TIMEOUT = 186,
HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME = 187,
LIVENESS_DEPTH_CHECK_FAILED = 190,
MRZ_QUALITY_WRONG_SYMBOL_POSITION = 200,
MRZ_QUALITY_WRONG_BACKGROUND = 201,
MRZ_QUALITY_WRONG_MRZ_WIDTH = 202,
MRZ_QUALITY_WRONG_MRZ_HEIGHT = 203,
MRZ_QUALITY_WRONG_LINE_POSITION = 204,
MRZ_QUALITY_WRONG_FONT_TYPE = 205,
OCR_QUALITY_TEXT_POSITION = 220,
OCR_QUALITY_INVALID_FONT = 221,
OCR_QUALITY_INVALID_BACKGROUND = 222,
LASINK_INVALID_LINES_FREQUENCY = 230,
DOC_LIVENESS_DOCUMENT_NOT_LIVE = 238,
DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED = 239,
DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED = 240,
DOC_LIVENESS_INVALID_BARCODE_BACKGROUND = 241,
CHD_ICAO_IDB_BASE32_ERROR = 243,
CHD_ICAO_IDB_ZIPPED_ERROR = 244,
CHD_ICAO_IDB_MESSAGE_ZONE_EMPTY = 245,
CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT = 246,
CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT = 247,
CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT = 248,
CHD_INCORRECT_OBJECT_COLOR = 250
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* 0 - result is negative; 1 - result is positive; 2 - сheck was not performed
* @export
* @enum {number}
*/
export declare enum CheckResult {
/**
* Check was performed and result is NEGATIVE
*/
ERROR = 0,
/**
* Check was performed and result is POSITIVE
*/
OK = 1,
/**
* Check was NOT PERFORMED
*/
WAS_NOT_DONE = 2
}
/**
* Contains information about one document type candidate
* @export
* @interface ChosenDocumentType
*/
export declare 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;
/**
* Indicates if the document of the given type is rotated by 180 degrees
* @type {number}
* @memberof ChosenDocumentType
*/
'Rotated180': 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;
/**
* Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme
* @type {number}
* @memberof ChosenDocumentType
*/
'OVIExp': number;
/**
*
* @type {number}
* @memberof ChosenDocumentType
*/
'RotationAngle'?: number;
}
/**
* @type ChosenDocumentTypeResult
* Contains information about the type of document that was determined based on the analysis of the provided image
* @export
*/
export declare type ChosenDocumentTypeResult = OneCandidateItem & ResultItem;
export declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
* @memberof Configuration
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
username?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
* @memberof Configuration
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePath?: string;
/**
* override server index
*
* @type {number}
* @memberof Configuration
*/
serverIndex?: number;
/**
* base options for axios calls
*
* @type {any}
* @memberof Configuration
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
export declare interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
/**
* List with various objects, containing processing results
* @export
* @interface ContainerList
*/
export declare interface ContainerList {
/**
* Length of list (Count for items)
* @type {number}
* @memberof ContainerList
*/
'Count'?: number;
/**
*
* @type {Array<ContainerListListInner>}
* @memberof ContainerList
*/
'List': Array<ContainerListListInner>;
}
/**
* @type ContainerListListInner
* @export
*/
export declare type ContainerListListInner = AuthenticityResult | ByteArrayResult | ChosenDocumentTypeResult | DocBarCodeInfo | DocumentBinaryInfoResult | DocumentImageResult | DocumentPositionResult | DocumentTypesCandidatesResult | EncryptedRCLResult | FaceDetectionResult | GraphicsResult | ImageQualityResult | ImagesResult | LexicalAnalysisResult | LicenseResult | MRZDetectorResult | MRZPositionResult | MRZTestQualityResult | RFIDGraphicsInfoResult | RFIDTextDataResult | StatusResult | TextDataResult | TextResult;
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Enumeration contains identifiers determining the criticality of the security element
* @export
* @enum {number}
*/
export declare 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
}
/**
*
* @export
* @interface CrossSourceValueComparison
*/
export declare interface CrossSourceValueComparison {
/**
*
* @type {Source}
* @memberof CrossSourceValueComparison
*/
'sourceLeft': Source;
/**
*
* @type {Source}
* @memberof CrossSourceValueComparison
*/
'sourceRight': Source;
/**
*
* @type {CheckResult}
* @memberof CrossSourceValueComparison
*/
'status': CheckResult;
}
/**
*
* @export
* @interface DataModule
*/
export declare 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 {BarCodeModuleType}
* @memberof DataModule
*/
'mType': BarCodeModuleType;
}
/**
* Details on performed optical checks
* @export
* @interface DetailsOptical
*/
export declare 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;
/**
*
* @type {number}
* @memberof DetailsOptical
*/
'vds'?: number;
}
/**
* Details on performed RFID checks
* @export
* @interface DetailsRFID
*/
export declare 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;
}
/**
*
* @export
* @interface DeviceInfo
*/
export declare interface DeviceInfo {
/**
* Application name.
* @type {string}
* @memberof DeviceInfo
*/
'app-name'?: string;
/**
* Product version.
* @type {string}
* @memberof DeviceInfo
*/
'version'?: string;
/**
* Unique license identifier.
* @type {string}
* @memberof DeviceInfo
*/
'license-id'?: string;
/**
* License serial number.
* @type {string}
* @memberof DeviceInfo
*/
'license-serial'?: string;
/**
*
* @type {string}
* @memberof DeviceInfo
*/
'license-type'?: string;
/**
* License validity date.
* @type {string}
* @memberof DeviceInfo
*/
'valid-until'?: string;
/**
*
* @type {string}
* @memberof DeviceInfo
*/
'server-time'?: string;
/**
* List of supported scenarios.
* @type {Array<string>}
* @memberof DeviceInfo
*/
'supported-scenarios'?: Array<string>;
/**
*
* @type {{ [key: string]: any; }}
* @memberof DeviceInfo
*/
'metadata'?: {
[key: string]: any;
};
/**
*
* @type {DeviceInfoDocumentsDatabase}
* @memberof DeviceInfo
*/
'documents-database'?: DeviceInfoDocumentsDatabase;
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Database information.
* @export
* @interface DeviceInfoDocumentsDatabase
*/
export declare interface DeviceInfoDocumentsDatabase {
/**
* Database identifier.
* @type {string}
* @memberof DeviceInfoDocumentsDatabase
*/
'id': string | null;
/**
* Database version.
* @type {string}
* @memberof DeviceInfoDocumentsDatabase
*/
'version': string | null;
/**
* Date of database creation.
* @type {string}
* @memberof DeviceInfoDocumentsDatabase
*/
'export-date': string | null;
/**
* Description of the database contents, such as the list of supported countries and documents.
* @type {string}
* @memberof DeviceInfoDocumentsDatabase
*/
'description': string | null;
}
/**
* @type DocBarCodeInfo
* Raw data from BarCodes
* @export
*/
export declare type DocBarCodeInfo = DocBarCodeInfoItem & ResultItem;
/**
*
* @export
* @interface DocBarCodeInfoFieldsList
*/
export declare interface DocBarCodeInfoFieldsList {
/**
* Count of array fields
* @type {number}
* @memberof DocBarCodeInfoFieldsList
*/
'nFields': number;
/**
* Data from barcode
* @type {Array<PArrayField>}
* @memberof DocBarCodeInfoFieldsList
*/
'pArrayFields': Array<PArrayField>;
}
/**
*
* @export
* @interface DocBarCodeInfoItem
*/
export declare interface DocBarCodeInfoItem {
/**
*
* @type {DocBarCodeInfoFieldsList}
* @memberof DocBarCodeInfoItem
*/
'DocBarCodeInfo': DocBarCodeInfoFieldsList;
}
/**
*
* @export
* @interface DocGraphicsInfoItem
*/
export declare interface DocGraphicsInfoItem {
/**
*
* @type {GraphicFieldsList}
* @memberof DocGraphicsInfoItem
*/
'DocGraphicsInfo': GraphicFieldsList;
}
/**
* @type DocumentBinaryInfoResult
* Structure is used to store the data reading results from the RFID-chip in a form of a list of the logically separated data groups.
* @export
*/
export declare type DocumentBinaryInfoResult = ResultItem & TDocBinaryInfoItem;
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
* Defining the geometric format of documents in accordance with ISO / IEC 7810
* @export
* @enum {number}
*/
export declare enum DocumentFormat {
/**
* Unknown document format
*/
UNKNOWN = -1,
/**
* ID1 document format
*/
ID1 = 0,
/**
* ID2 document format
*/
ID2 = 1,
/**
* ID3 document format
*/
ID3 = 2,
/**
* Undefined document format
*/
NON = 3,
/**
* A4 document format
*/
A4 = 4,
/**
* ID3 double document format
*/
ID3_X2 = 5,
/**
* ID1 format document rotated 90 °
*/
ID1_90 = 10,
/**
* ID1 format document rotated 180 °
*/
ID1_180 = 11,
/**
* ID1 format document rotated 270 °
*/
ID1_270 = 12,
/**
* ID2 format document rotated 90 °
*/
ID2_180 = 13,
/**
* ID3 format document rotated 180 °
*/
ID3_180 = 14,
/**
* Arbitrary format
*/
CUSTOM = 1000,
/**
* Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background...
*/
FLEXIBLE = 1002
}
/**
* NOTE: This file is auto generated by OpenAPI Generator.
* Do not edit the file manually.
*/
/**
*
* @export
* @interface DocumentImage
*/
export declare interface DocumentImage {
/**
* Base64 encoded image
* @type {string}
* @memberof DocumentImage
*/
'image'?: string;
/**
* Image format
* @type {string}
* @memberof DocumentImage
*/
'format'?: string;
}
/**
* @type DocumentImageResult
* Contains document image.
* @export
*/
export declare type DocumentImageResult = RawImageContainerItem & ResultItem;
/**
*
* @export
* @interface DocumentPosition
*/
export declare interface DocumentPosition {
/**
*
* @type {DocumentFormat}
* @memberof DocumentPosition
*/
'docFormat': DocumentFormat;
/**
* Document rotation angle
* @type {number}
* @memberof DocumentPosition
*/
'Angle': number;
/**
* Document width
* @type {number}
* @memberof DocumentPosition
*/
'Width': number;
/**
* Document height
* @type {number}
* @memberof DocumentPosition
*/
'Height': number;
/**
*
* @type {Point}
* @memberof DocumentPosition
*/
'Center': Point;
/**
*
* @type {Point}
* @memberof DocumentPosition
*/
'LeftBottom': Point;
/**
*
* @type {Point}
* @memberof DocumentPosition
*/
'LeftTop': Point;
/**
*
* @type {Point}
* @memberof DocumentPosition
*/
'RightBottom': Point;
/**
*
* @type {Point}
* @memberof DocumentPosition
*/
'RightTop': Point;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'Dpi': number;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'Inverse'?: number;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'ObjArea'?: number;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'ObjIntAngleDev'?: number;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'PerspectiveTr'?: number;
/**
*
* @type {number}
* @memberof DocumentPosition
*/
'ResultStatus'?: number;
}
/**
*
* @export
* @interface DocumentPositionItem
*/
export declare interface DocumentPositionItem {
/**
*
* @type {DocumentPosition}
* @memberof DocumentPositionItem
*/
'DocumentPosition': DocumentPosition;
}
/**
* @type DocumentPositionResult
* Contains information about document position on the input image, its center, angle, etc
* @export
*/
export declare type DocumentPositionResult = DocumentPositionItem & ResultItem;
export declare class DocumentReaderApi {
private readonly healthcheckApi;
private readonly processApi;
private readonly transactionApi;
private license;
constructor(configuration?: ConfigurationParameters, basePath?: string, axios?: AxiosInstance);
ping(xRequestID?: string): Promise<DeviceInfo>;
health(xRequestID?: string): Promise<Healthcheck>;
/**
*
* @summary Process list of documents images and return extracted data
* @param {ProcessRequestExt} [request] Request options such as image, results types and etc.
* @param {*} [options] Override http request option.
* @throws {RequiredError} If some request params are missed
* */
process(request: ProcessRequestExt | ProcessRequest, xRequestID?: string, options?: any): Promise<ProcessResult>;
setLicense(license: ArrayBuffer | Base64String): void;
/**
*
* @summary Reprocess
* @param {string} transactionId Transaction id
* @param {TransactionProcessRequest} transactionProcessRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<TransactionProcessResult, any>>;
/**
*