@regulaforensics/document-reader-webclient 7.5.170-nightly → 7.5.172-nightly

package/lib/index.d.ts

@@ -423,11 +423,11 @@ export enum AuthenticityResultType {
     */
     PHOTO_EMBED_TYPE = 512,
     /**
-    * OVI check
+    * OVI check. Deprecated, use Document liveness check instead
     */
     OVI = 1024,
     /**
-    * Hologram presence check
+    * Hologram presence check. Deprecated
     */
     HOLOGRAMS = 4096,
     /**
@@ -667,6 +667,12 @@ export interface ImageData {
      * @memberof ImageData
      */
     image: string;
+    /**
+     * Image format
+     * @type {string}
+     * @memberof ImageData
+     */
+    format?: string;
 }
 /**
  * Regula Document Reader Web API
@@ -2830,7 +2836,7 @@ export interface DocBarCodeInfoAllOf {
     DocBarCodeInfo?: DocBarCodeInfoFieldsList;
 }
 /**
- * Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image
+ *
  * @export
  * @interface DocumentImageResultAllOf
  */
@@ -7591,6 +7597,7 @@ export type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf &
 export type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
 /**
  * @type DocumentImageResult
+ * Contains document image.
  * @export
  */
 export type DocumentImageResult = DocumentImageResultAllOf & ResultItem;
@@ -7768,6 +7775,12 @@ export interface DocumentImage {
      * @memberof DocumentImage
      */
     image: string;
+    /**
+     * Image format
+     * @type {string}
+     * @memberof DocumentImage
+     */
+    format?: string;
 }
 /**
  *
@@ -7898,10 +7911,10 @@ export interface FaceApi {
 export interface GetTransactionsByTagResponse {
     /**
      * Transaction id
-     * @type {number}
+     * @type {string}
      * @memberof GetTransactionsByTagResponse
      */
-    id?: number;
+    id?: string;
     /**
      * Transaction status
      * @type {number}
@@ -7915,6 +7928,103 @@ export interface GetTransactionsByTagResponse {
      */
     updatedAt?: string;
 }
+/**
+ * Regula Document Reader Web API
+ * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
+ *
+ * The version of the OpenAPI document: 7.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Database information.
+ * @export
+ * @interface HealthcheckDocumentsDatabase
+ */
+export interface HealthcheckDocumentsDatabase {
+    /**
+     * Database identifier.
+     * @type {string}
+     * @memberof HealthcheckDocumentsDatabase
+     */
+    id: string | null;
+    /**
+     * Database version.
+     * @type {string}
+     * @memberof HealthcheckDocumentsDatabase
+     */
+    version: string | null;
+    /**
+     * Date of database creation.
+     * @type {string}
+     * @memberof HealthcheckDocumentsDatabase
+     */
+    exportDate: string | null;
+    /**
+     * Description of the database contents, such as the list of supported countries and documents.
+     * @type {string}
+     * @memberof HealthcheckDocumentsDatabase
+     */
+    description: string | null;
+}
+/**
+ *
+ * @export
+ * @interface Healthcheck
+ */
+export interface Healthcheck {
+    /**
+     * Application name.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    app: string;
+    /**
+     * Unique license identifier.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    licenseId: string | null;
+    /**
+     * License type.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    licenseType: string | null;
+    /**
+     * License serial number.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    licenseSerial: string | null;
+    /**
+     * License validity date.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    licenseValidUntil: string | null;
+    /**
+     * List of supported scenarios.
+     * @type {Array<string>}
+     * @memberof Healthcheck
+     */
+    scenarios: Array<string> | null;
+    /**
+     * Product version.
+     * @type {string}
+     * @memberof Healthcheck
+     */
+    version: string | null;
+    /**
+     *
+     * @type {HealthcheckDocumentsDatabase}
+     * @memberof Healthcheck
+     */
+    documentsDatabase?: HealthcheckDocumentsDatabase;
+}
 /**
  * Regula Document Reader Web API
  * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
@@ -9814,10 +9924,17 @@ export interface ProcessParams {
      */
     imageQa?: ImageQA;
     /**
-     * When enabled, image quality checks status affects document optical and overall status. Disabled by default.
+     * When enabled, the image quality check status affects the document optical and overall status. Disabled by default.
      * @type {boolean}
      * @memberof ProcessParams
      */
+    strictImageQuality?: boolean;
+    /**
+     * Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     * @deprecated
+     */
     respectImageQuality?: boolean;
     /**
      *
@@ -9969,6 +10086,12 @@ export interface ProcessParams {
      * @memberof ProcessParams
      */
     generateNumericCodes?: boolean;
+    /**
+     * This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    strictBarcodeDigitalSignatureCheck?: boolean;
 }
 /**
  *
@@ -10093,6 +10216,12 @@ export interface ProcessRequest {
     passBackObject?: {
         [key: string]: object;
     };
+    /**
+     * URLs to the document images for processing.
+     * @type {Array<string>}
+     * @memberof ProcessRequest
+     */
+    ImageUrls?: Array<string>;
 }
 /**
  *
@@ -10172,10 +10301,10 @@ export interface TransactionImage {
 export interface TransactionProcessGetResponse {
     /**
      *
-     * @type {number}
+     * @type {string}
      * @memberof TransactionProcessGetResponse
      */
-    transactionId?: number;
+    transactionId?: string;
     /**
      *
      * @type {string}
@@ -10454,25 +10583,25 @@ export class DocumentReaderApi {
     /**
      *
      * @summary Reprocess
-     * @param {number} transactionId Transaction id
+     * @param {string} transactionId Transaction id
      * @param {TransactionProcessRequest} transactionProcessRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    reprocessTransaction(transactionId: number, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<InlineResponse200, any>>;
+    reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<InlineResponse200, any>>;
     /**
      *
      * @summary Get Reprocess transaction result
-     * @param {number} transactionId Transaction id
+     * @param {string} transactionId Transaction id
      * @param {boolean} [withImages] With base64 images or url
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionResult(transactionId: number, withImages?: boolean, options?: any): Promise<Response>;
+    getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: any): Promise<Response>;
     /**
      *
      * @summary Get transactions by tag
-     * @param {number} tagId Tag id
+     * @param {string} tagId Tag id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -10480,27 +10609,27 @@ export class DocumentReaderApi {
     /**
      *
      * @summary Delete Reprocess transactions by tag
-     * @param {number} tagId Tag id
+     * @param {string} tagId Tag id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteReprocessTransactionsByTag(tagId: number, options?: any): Promise<AxiosResponse<object, any>>;
+    deleteReprocessTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<object, any>>;
     /**
      *
      * @summary Get Reprocess transaction file
-     * @param {number} transactionId Transaction id
+     * @param {string} transactionId Transaction id
      * @param {string} name File name
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionFile(transactionId: number, name: string, options?: any): Promise<AxiosResponse<any, any>>;
+    getReprocessTransactionFile(transactionId: string, name: string, options?: any): Promise<AxiosResponse<any, any>>;
     /**
      *
      * @summary Get Reprocess transaction data
-     * @param {number} transactionId Transaction id
+     * @param {string} transactionId Transaction id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReprocessTransactionData(transactionId: number, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
+    getReprocessTransactionData(transactionId: string, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
 }
 export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;

package/package.json

@@ -5,7 +5,7 @@
     "> 0.2%",
     "not dead"
   ],
-  "version": "7.5.170-nightly",
+  "version": "7.5.172-nightly",
   "description": "Regula Document Reader js client for the browser and node.js based on axios",
   "author": "Regula Forensics, Inc.",
   "keywords": [