@regulaforensics/facesdk-webclient 4.1.5 → 5.1.0

package/src/models/faces-response.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
+ *
+ * The version of the OpenAPI document: 4.1.3
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DetectionFace } from './detection-face';
+import { FacesResponseAllOf } from './faces-response-all-of';
+import { PersonWithImages } from './person-with-images';
+
+/**
+ * @type FacesResponse
+ * @export
+ */
+export type FacesResponse = DetectionFace & FacesResponseAllOf;
+
+

package/src/models/image-source.ts

@@ -25,7 +25,8 @@ export const ImageSource = {
     DOCUMENT_RFID: 2,
     LIVE: 3,
     DOCUMENT_WITH_LIVE: 4,
-    EXTERNAL: 5
+    EXTERNAL: 5,
+    GHOST: 6
 } as const;
 
 export type ImageSource = typeof ImageSource[keyof typeof ImageSource];

package/src/models/index.ts

@@ -13,6 +13,8 @@ export * from './face-quality-config-name';
 export * from './face-quality-scenarios';
 export * from './face-sdkresult';
 export * from './face-sdkresult-code';
+export * from './faces-response';
+export * from './faces-response-all-of';
 export * from './group';
 export * from './group-all-of';
 export * from './group-page';
@@ -24,6 +26,7 @@ export * from './image-fields-image';
 export * from './image-page';
 export * from './image-page-all-of';
 export * from './image-source';
+export * from './liveness-transaction';
 export * from './match-and-search-request';
 export * from './match-and-search-request-all-of';
 export * from './match-and-search-request-all-of-images';

package/src/models/liveness-transaction.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
+ *
+ * The version of the OpenAPI document: 4.1.3
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface LivenessTransaction
+ */
+export interface LivenessTransaction {
+    /**
+     * 
+     * @type {number}
+     * @memberof LivenessTransaction
+     */
+    'code'?: number;
+    /**
+     * A free-form object containing additional transaction attributes.
+     * @type {{ [key: string]: object; }}
+     * @memberof LivenessTransaction
+     */
+    'config'?: { [key: string]: object; };
+    /**
+     * 
+     * @type {number}
+     * @memberof LivenessTransaction
+     */
+    'elapsed'?: number;
+    /**
+     * URL for portrait image
+     * @type {string}
+     * @memberof LivenessTransaction
+     */
+    'portrait'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LivenessTransaction
+     */
+    'sessionId'?: string;
+    /**
+     * Whether the liveness detection is confirmed (0) or not (1)
+     * @type {number}
+     * @memberof LivenessTransaction
+     */
+    'status'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof LivenessTransaction
+     */
+    'transactionId'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LivenessTransaction
+     */
+    'video'?: string;
+    /**
+     * A free-form object containing the request information (server time, client IP, etc.).
+     * @type {{ [key: string]: object; }}
+     * @memberof LivenessTransaction
+     */
+    'metadata'?: { [key: string]: object; };
+}
+

package/src/models/match-and-search-response-all-of-detections.ts

@@ -13,9 +13,8 @@
  */
 
 
-import { DetectionFace } from './detection-face';
 import { FaceSDKResultCode } from './face-sdkresult-code';
-import { PersonWithImages } from './person-with-images';
+import { FacesResponse } from './faces-response';
 
 /**
  * 
@@ -25,10 +24,10 @@ import { PersonWithImages } from './person-with-images';
 export interface MatchAndSearchResponseAllOfDetections {
     /**
      * 
-     * @type {Array<DetectionFace & object>}
+     * @type {Array<FacesResponse>}
      * @memberof MatchAndSearchResponseAllOfDetections
      */
-    'faces'?: Array<DetectionFace & object>;
+    'faces'?: Array<FacesResponse>;
     /**
      * Image index used to identify input photos between themselves. If not specified, than input list index is used.
      * @type {number}

package/src/models/match-and-search-response-all-of.ts

@@ -24,16 +24,10 @@ import { MatchImageResult } from './match-image-result';
 export interface MatchAndSearchResponseAllOf {
     /**
      * 
-     * @type {Array<MatchAndSearchResponseAllOfDetections>}
-     * @memberof MatchAndSearchResponseAllOf
-     */
-    'detections'?: Array<MatchAndSearchResponseAllOfDetections>;
-    /**
-     * 
-     * @type {MatchImageResult}
+     * @type {Array<MatchImageResult>}
      * @memberof MatchAndSearchResponseAllOf
      */
-    'results'?: MatchImageResult;
+    'results'?: Array<MatchImageResult>;
     /**
      * 
      * @type {number}
@@ -46,5 +40,11 @@ export interface MatchAndSearchResponseAllOf {
      * @memberof MatchAndSearchResponseAllOf
      */
     'metadata'?: { [key: string]: object; };
+    /**
+     * 
+     * @type {Array<MatchAndSearchResponseAllOfDetections>}
+     * @memberof MatchAndSearchResponseAllOf
+     */
+    'detections'?: Array<MatchAndSearchResponseAllOfDetections>;
 }
 

package/src/models/search-parameters.ts

@@ -27,7 +27,7 @@ export interface SearchParameters {
      */
     'limit'?: number;
     /**
-     * The similarity distance threshold.
+     * The similarity distance threshold, should be between 0.0 and 2.0, where 0.0 is for returning results for only the most similar persons and 2.0 is for all the persons, even the dissimilar ones. If not set, the default 1.0 value is used.
      * @type {number}
      * @memberof SearchParameters
      */