@regulaforensics/document-reader-webclient 6.8.3 → 11.4.17

package/src/models/face-api-search.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 6.8.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * A search filter that can be applied if the \"match+search\" mode is enabled. May include limit, threshold, group_ids. If the group_ids are specified, the search is performed only in these groups. Find more information in the <a href=\"https://dev.regulaforensics.com/FaceSDK-web-openapi/#tag/search/operation/search\" target=\"_blank\">OpenAPI documentation</a>.
+ * @export
+ * @interface FaceApiSearch
+ */
+export interface FaceApiSearch {
+    /**
+     * The maximum number of results to be returned.
+     * @type {number}
+     * @memberof FaceApiSearch
+     */
+    limit?: number;
+    /**
+     * The similarity threshold.
+     * @type {number}
+     * @memberof FaceApiSearch
+     */
+    threshold?: number;
+    /**
+     *  The groups where to conduct the search.
+     * @type {Array<number>}
+     * @memberof FaceApiSearch
+     */
+    group_ids?: Array<number>;
+}
+
+

package/src/models/face-api.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 6.8.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { FaceApiSearch } from './face-api-search';
+
+/**
+ * 
+ * @export
+ * @interface FaceApi
+ */
+export interface FaceApi {
+    /**
+     * The URL of the Regula Face Web service to be used.
+     * @type {string}
+     * @memberof FaceApi
+     */
+    url?: string;
+    /**
+     * The processing mode: \"match\" or \"match+search\".
+     * @type {string}
+     * @memberof FaceApi
+     */
+    mode?: string;
+    /**
+     * 
+     * @type {FaceApiSearch}
+     * @memberof FaceApi
+     */
+    search?: FaceApiSearch;
+    /**
+     * The similarity threshold, 0-100. Above 75 means that the faces\' similarity is verified, below 75 is not.
+     * @type {number}
+     * @memberof FaceApi
+     */
+    threshold?: number;
+    /**
+     * The Regula Face Web service requests timeout, ms.
+     * @type {number}
+     * @memberof FaceApi
+     */
+    serviceTimeout?: number;
+    /**
+     * Proxy to use, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXY.html\" target=\"_blank\">cURL standard</a>.
+     * @type {string}
+     * @memberof FaceApi
+     */
+    proxy?: string;
+    /**
+     * Username and password to use for proxy authentication, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYUSERPWD.html\" target=\"_blank\">cURL standard</a>.
+     * @type {string}
+     * @memberof FaceApi
+     */
+    proxy_userpwd?: string;
+    /**
+     * Proxy protocol type, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYTYPE.html\" target=\"_blank\">cURL standard</a>.
+     * @type {number}
+     * @memberof FaceApi
+     */
+    proxy_type?: number;
+}
+
+

package/src/models/index.ts

@@ -40,6 +40,8 @@ export * from './document-types-candidates-result-all-of.js';
 export * from './encrypted-rclresult.js';
 export * from './encrypted-rclresult-all-of.js';
 export * from './fdsidlist.js';
+export * from './face-api.js';
+export * from './face-api-search.js';
 export * from './fiber-result.js';
 export * from './fiber-result-all-of.js';
 export * from './graphic-field.js';

package/src/models/log-level.ts

@@ -20,10 +20,25 @@
  * @enum {string}
  */
 export enum LogLevel {
+    /**
+    * Fatal error
+    */
     FATAL_ERROR = 'FatalError',
+    /**
+    * Error
+    */
     ERROR = 'Error',
+    /**
+    * Warning
+    */
     WARNING = 'Warning',
+    /**
+    * Info
+    */
     INFO = 'Info',
+    /**
+    * Debug
+    */
     DEBUG = 'Debug'
 }
 

package/src/models/mrzformat.ts

@@ -20,11 +20,29 @@
  * @enum {string}
  */
 export enum MRZFormat {
+    /**
+    * 1x30
+    */
     IDL = '1x30',
+    /**
+    * 3x30
+    */
     ID1 = '3x30',
+    /**
+    * 2x36
+    */
     ID2 = '2x36',
+    /**
+    * 2x44
+    */
     ID3 = '2x44',
+    /**
+    * 1x6
+    */
     CAN = '1x6',
+    /**
+    * 2x30
+    */
     ID1_2_30 = '2x30'
 }