import { Document } from '../../common/shared/models/Document'; import type { Dictionary } from '../../../types/index.js'; import { BaseClient } from './BaseClient'; import type { FrankieApiClient } from '../FrankieApiClient'; export declare class OCRClient extends BaseClient { constructor(frankie: FrankieApiClient); attachNewOCRDocument(file?: File, digital?: boolean, token?: string, vendorParameters?: Dictionary): Promise; rerun(documentId: string): Promise; updateOCRDocument(file: File, documentId: string | null, scanId?: string): Promise; } export type OCRResults = { ocrDocument: Document; documentStatus: OCRStatus; failureKVPExtract?: Record; }; export declare enum OCRStatus { WAITING_OCR_RUN = "AWAITING_DOCUMENT_OCR", WAITING_BACK = "AWAITING_DOCUMENT_UPLOAD_BACK", WAITING_FRONT = "AWAITING_DOCUMENT_UPLOAD_FRONT", COMPLETE = "COMPLETE_OCR", DOCUMENTS_INVALID = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE", DOCUMENTS_UPLOAD_FAILED = "AWAITING_DOCUMENT_UPLOAD_FAILED_OCR", PROVIDER_OFFLINE = "AWAITING_OCR_RESULTS_PROVIDER_OFFLINE", FAILED_FILE_SIZE = "DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT", FAILED_FILE_FORMAT = "DOCUMENT_INVALID_INCORRECT_FILE_FORMAT", INTERRUPTED = "INTERRUPTED", FAILED = "FAILED", SHARE_DECLINED = "SHARE_DECLINED" } export type FailedStatus = OCRStatus.DOCUMENTS_UPLOAD_FAILED | OCRStatus.DOCUMENTS_INVALID | OCRStatus.FAILED_FILE_FORMAT | OCRStatus.FAILED_FILE_SIZE | OCRStatus.INTERRUPTED | OCRStatus.FAILED | OCRStatus.SHARE_DECLINED; export type CompleteStatus = OCRStatus.COMPLETE; export type InputRequiredStatus = OCRStatus.WAITING_BACK | OCRStatus.WAITING_FRONT; export declare const isCompleteStatus: (status?: OCRStatus) => status is CompleteStatus; export declare const isInputRequiredStatus: (status?: OCRStatus) => status is InputRequiredStatus; export declare const isFailedStatus: (status?: OCRStatus) => status is FailedStatus; export type OCRDocumentType = 'DRIVERS_LICENCE' | 'PASSPORT'; //# sourceMappingURL=OCRClient.d.ts.map