Class DocumentReaderApi

Index

Constructors

Methods

deleteReprocessTransactionsByTag doclist getReprocessTransactionData getReprocessTransactionFile getReprocessTransactionResult getTransactionsByTag health ping process reprocessTransaction setLicense

Constructors

constructor

new DocumentReaderApi(
    configuration?: ConfigurationParameters,
    basePath?: string,
    axios?: AxiosInstance,
): DocumentReaderApi
Parameters
- Optionalconfiguration: ConfigurationParameters
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns DocumentReaderApi

Methods

deleteReprocessTransactionsByTag

deleteReprocessTransactionsByTag(
tagId: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<object, any, {}>>
Parameters
- tagId: string
  Tag id
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<object, any, {}>>

Throws

doclist

doclist(options?: RawAxiosRequestConfig): Promise<DatabaseDocumentList>
Parameters
- Optionaloptions: RawAxiosRequestConfig
Returns Promise<DatabaseDocumentList>

getReprocessTransactionData

getReprocessTransactionData(
transactionId: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionProcessGetResponse, any, {}>>
Parameters
- transactionId: string
  Transaction id
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionProcessGetResponse, any, {}>>

Throws

getReprocessTransactionFile

getReprocessTransactionFile(
    transactionId: string,
    name: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<any, any, {}>>
Parameters
- transactionId: string
  Transaction id
- name: string
  File name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<any, any, {}>>

Throws

getReprocessTransactionResult

getReprocessTransactionResult(
    transactionId: string,
    withImages?: boolean,
    options?: RawAxiosRequestConfig,
): Promise<ProcessResult>
Parameters
- transactionId: string
  Transaction id
- OptionalwithImages: boolean
  With base64 images or url
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<ProcessResult>

Throws

getTransactionsByTag

getTransactionsByTag(
tagId: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListTransactionsByTagResponse, any, {}>>
Parameters
- tagId: string
  Tag id
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListTransactionsByTagResponse, any, {}>>

Throws

health

health(
xRequestID?: string,
options?: RawAxiosRequestConfig,
): Promise<Healthcheck>
Parameters
- OptionalxRequestID: string
- Optionaloptions: RawAxiosRequestConfig
Returns Promise<Healthcheck>

ping

ping(xRequestID?: string, options?: RawAxiosRequestConfig): Promise<DeviceInfo>
Parameters
- OptionalxRequestID: string
- Optionaloptions: RawAxiosRequestConfig
Returns Promise<DeviceInfo>

process

process(
    request?: ProcessRequestExt | ProcessRequest,
    xRequestID?: string,
    options?: RawAxiosRequestConfig,
): Promise<ProcessResult>
Parameters
- Optionalrequest: ProcessRequestExt | ProcessRequest
  Request options such as image, results types and etc.
- OptionalxRequestID: string
  It allows the client and server to correlate each HTTP request.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<ProcessResult>

Throws
If some request params are missed

reprocessTransaction

reprocessTransaction(
    transactionId: string,
    transactionProcessRequest: TransactionProcessRequest,
    useCache?: boolean,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionProcessResult, any, {}>>
Parameters
- transactionId: string
  Transaction id
- transactionProcessRequest: TransactionProcessRequest
- OptionaluseCache: boolean
  Get processed values from storage in case transaction has already processed.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionProcessResult, any, {}>>

Throws

setLicense

setLicense(license: string | ArrayBuffer): void
Parameters
- license: string | ArrayBuffer
Returns void

Class DocumentReaderApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DocumentReaderApi

Methods

deleteReprocessTransactionsByTag

Parameters

Returns Promise<AxiosResponse<object, any, {}>>

Throws

doclist

Parameters

Returns Promise<DatabaseDocumentList>

getReprocessTransactionData

Parameters

Returns Promise<AxiosResponse<TransactionProcessGetResponse, any, {}>>

Throws

getReprocessTransactionFile

Parameters

Returns Promise<AxiosResponse<any, any, {}>>

Throws

getReprocessTransactionResult

Parameters

Returns Promise<ProcessResult>

Throws

getTransactionsByTag

Parameters

Returns Promise<AxiosResponse<ListTransactionsByTagResponse, any, {}>>

Throws

health

Parameters

Returns Promise<Healthcheck>

ping

Parameters

Returns Promise<DeviceInfo>

process

Parameters

Returns Promise<ProcessResult>

Throws

reprocessTransaction

Parameters

Returns Promise<AxiosResponse<TransactionProcessResult, any, {}>>

Throws

setLicense

Parameters

Returns void

Settings

On This Page