DocumentDataProvider

interface DocumentDataProvider

Functions

checkDocumentsStatusImmediate

abstract suspend fun checkDocumentsStatusImmediate(vararg ids: String): DataProviderResponse<GetDocumentStatusResponse>

Check the current DocumentStatus of one or more documents

abstract suspend fun checkDocumentsStatusImmediate(ids: List<String>): DataProviderResponse<GetDocumentStatusResponse>

deleteDocuments

abstract suspend fun deleteDocuments(requestBody: DeleteDocumentBody): DataProviderResponse<DeleteDocumentResponse>

Delete one or more documents

abstract suspend fun deleteDocuments(vararg ids: String): DataProviderResponse<DeleteDocumentResponse>

Delete one or more documents by id

abstract suspend fun deleteDocuments(ids: List<String>): DataProviderResponse<DeleteDocumentResponse>

downloadDocumentImage

abstract suspend fun downloadDocumentImage(documentId: String, saveDir: File, overwriteCache: Boolean = false): DataProviderResponse<File>

Download the original document image for the document represented by documentId to the saveDir folder.

editDocument

abstract suspend fun editDocument(id: String, requestBody: EditDocumentBody): DataProviderResponse<String>

Edit the document with id - will modify the provided fields in the requestBody

getDocumentById

abstract suspend fun getDocumentById(id: String): DataProviderResponse<GetDocumentResponse>

Fetch a full document model by document id

getDocumentList

abstract suspend fun getDocumentList(params: DocumentListRequestParams): DataProviderResponse<DocumentListResponse>

Fetch a list of documents with configurable limit/search/filter parameters

longPollDocumentsStatus

abstract suspend fun longPollDocumentsStatus(vararg ids: String): DataProviderResponse<GetDocumentStatusResponse>

Long poll / wait for the DocumentStatus of one or more documents.

abstract suspend fun longPollDocumentsStatus(ids: List<String>): DataProviderResponse<GetDocumentStatusResponse>

uploadDocument

abstract suspend fun uploadDocument(payload: DocumentUploadPayload): DataProviderResponse<String>

Inheritors

TestDocumentDataProvider

DocumentDataProviderImpl