@regulaforensics/document-reader-webclient 8.4.583-rc → 8.4.585-rc

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { AxiosInstance } from 'axios';
 import { AxiosResponse } from 'axios';
+import { RawAxiosRequestConfig } from 'axios';
 
 /**
  *
@@ -1612,6 +1613,118 @@ export declare interface CrossSourceValueComparison {
     'status': CheckResult;
 }
 
+/**
+ *
+ * @export
+ * @interface DatabaseDocument
+ */
+export declare interface DatabaseDocument {
+    /**
+     * Whether the document has a barcode.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'barcode_fields': boolean;
+    /**
+     * Country name.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'country': string;
+    /**
+     * Date when the document description was created in the database.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'createad': string;
+    /**
+     *
+     * @type {DocumentType}
+     * @memberof DatabaseDocument
+     */
+    'doc_type': DocumentType_2;
+    /**
+     * Document name.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'document': string;
+    /**
+     * The presence of graphic fields in the document.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'graphic_fields': boolean;
+    /**
+     * Document code.
+     * @type {number}
+     * @memberof DatabaseDocument
+     */
+    'id': number;
+    /**
+     * The document has an MRZ.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'mrz': boolean;
+    /**
+     * Country region.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'region'?: string;
+    /**
+     * The document has an RFID chip.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'rfid_chip': boolean;
+    /**
+     * The presence of text fields in the document.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'text_fields': boolean;
+    /**
+     * Date when the document description was updated in the database.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'updated': string;
+    /**
+     * The year when the document was issued.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'year'?: string;
+    /**
+     * Guardian country.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'sovereignty'?: string;
+    /**
+     * Whether the document is no longer in circulation.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'deprecated'?: boolean;
+}
+
+/**
+ *
+ * @export
+ * @interface DatabaseDocumentList
+ */
+export declare interface DatabaseDocumentList {
+    /**
+     * The list of documents stored in the database.
+     * @type {Array<DatabaseDocument>}
+     * @memberof DatabaseDocumentList
+     */
+    'items': Array<DatabaseDocument>;
+}
+
 /**
  *
  * @export
@@ -2152,28 +2265,32 @@ export declare class DocumentReaderApi {
     private readonly healthcheckApi;
     private readonly processApi;
     private readonly transactionApi;
+    private readonly resourcesApi;
     private license;
     constructor(configuration?: ConfigurationParameters, basePath?: string, axios?: AxiosInstance);
-    ping(xRequestID?: string): Promise<DeviceInfo>;
-    health(xRequestID?: string): Promise<Healthcheck>;
+    doclist(options?: RawAxiosRequestConfig): Promise<DatabaseDocumentList>;
+    ping(xRequestID?: string, options?: RawAxiosRequestConfig): Promise<DeviceInfo>;
+    health(xRequestID?: string, options?: RawAxiosRequestConfig): 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 {string} xRequestID It allows the client and server to correlate each HTTP request.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError} If some request params are missed
      * */
-    process(request: ProcessRequestExt | ProcessRequest, xRequestID?: string, options?: any): Promise<ProcessResult>;
+    process(request: ProcessRequestExt | ProcessRequest, xRequestID?: string, options?: RawAxiosRequestConfig): Promise<ProcessResult>;
     setLicense(license: ArrayBuffer | Base64String): void;
     /**
      *
      * @summary Reprocess
      * @param {string} transactionId Transaction id
      * @param {TransactionProcessRequest} transactionProcessRequest
+     * @param {boolean} useCache Get processed values from storage in case transaction has already processed.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<TransactionProcessResult, any>>;
+    reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean, options?: RawAxiosRequestConfig): Promise<AxiosResponse<TransactionProcessResult, any>>;
     /**
      *
      * @summary Get Reprocess transaction result
@@ -2182,7 +2299,7 @@ export declare class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: any): Promise<ProcessResult>;
+    getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: RawAxiosRequestConfig): Promise<ProcessResult>;
     /**
      *
      * @summary Get transactions by tag
@@ -2190,7 +2307,7 @@ export declare class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<ListTransactionsByTagResponse>>;
+    getTransactionsByTag(tagId: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<ListTransactionsByTagResponse>>;
     /**
      *
      * @summary Delete Reprocess transactions by tag
@@ -2198,7 +2315,7 @@ export declare class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteReprocessTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<object, any>>;
+    deleteReprocessTransactionsByTag(tagId: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<object, any>>;
     /**
      *
      * @summary Get Reprocess transaction file
@@ -2207,7 +2324,7 @@ export declare class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionFile(transactionId: string, name: string, options?: any): Promise<AxiosResponse<any, any>>;
+    getReprocessTransactionFile(transactionId: string, name: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<any, any>>;
     /**
      *
      * @summary Get Reprocess transaction data
@@ -2215,7 +2332,7 @@ export declare class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionData(transactionId: string, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
+    getReprocessTransactionData(transactionId: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
 }
 
 /**
@@ -8839,6 +8956,12 @@ export declare interface ProcessParams {
      * @memberof ProcessParams
      */
     'strictSecurityChecks'?: boolean;
+    /**
+     * Allows transliteration to be turned on or off; by default, it is enabled.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    'returnTransliteratedFields'?: boolean;
 }
 
 /**