@regulaforensics/facesdk-webclient 5.1.0 → 5.2.0

package/src/api/liveness20-api.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the OpenAPI document: 5.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,7 +21,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
-import { LivenessTransaction } from '../models';
+import { TransactionInfo } from '../models';
 /**
  * Liveness20Api - axios parameter creator
  * @export
@@ -30,14 +30,14 @@ export const Liveness20ApiAxiosParamCreator = function (configuration?: Configur
     return {
         /**
          * 
-         * @summary liveness
+         * @summary Liveness assessment
          * @param {number} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLivenessTransaction: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getLivenessTransactionInfo: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'transactionId' is not null or undefined
-            assertParamExists('getLivenessTransaction', 'transactionId', transactionId)
+            assertParamExists('getLivenessTransactionInfo', 'transactionId', transactionId)
             const localVarPath = `/api/v2/liveness`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -56,117 +56,6 @@ export const Liveness20ApiAxiosParamCreator = function (configuration?: Configur
 
 
     
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-        /**
-         * 
-         * @summary metadata
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessMetadata: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'transactionId' is not null or undefined
-            assertParamExists('livenessMetadata', 'transactionId', transactionId)
-            const localVarPath = `/api/v2/liveness/metadata`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            if (transactionId !== undefined) {
-                localVarQueryParameter['transactionId'] = transactionId;
-            }
-
-
-    
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-        /**
-         * 
-         * @summary portrait
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessPortrait: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'transactionId' is not null or undefined
-            assertParamExists('livenessPortrait', 'transactionId', transactionId)
-            const localVarPath = `/api/v2/liveness/portrait`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            if (transactionId !== undefined) {
-                localVarQueryParameter['transactionId'] = transactionId;
-            }
-
-
-    
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-        /**
-         * 
-         * @summary video
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessVideo: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'transactionId' is not null or undefined
-            assertParamExists('livenessVideo', 'transactionId', transactionId)
-            const localVarPath = `/api/v2/liveness/video`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            if (transactionId !== undefined) {
-                localVarQueryParameter['transactionId'] = transactionId;
-            }
-
-
-    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -188,46 +77,13 @@ export const Liveness20ApiFp = function(configuration?: Configuration) {
     return {
         /**
          * 
-         * @summary liveness
+         * @summary Liveness assessment
          * @param {number} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getLivenessTransaction(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivenessTransaction>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getLivenessTransaction(transactionId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-        },
-        /**
-         * 
-         * @summary metadata
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        async livenessMetadata(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: object; }>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.livenessMetadata(transactionId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-        },
-        /**
-         * 
-         * @summary portrait
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        async livenessPortrait(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.livenessPortrait(transactionId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-        },
-        /**
-         * 
-         * @summary video
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        async livenessVideo(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.livenessVideo(transactionId, options);
+        async getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionInfo>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLivenessTransactionInfo(transactionId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -242,43 +98,13 @@ export const Liveness20ApiFactory = function (configuration?: Configuration, bas
     return {
         /**
          * 
-         * @summary liveness
+         * @summary Liveness assessment
          * @param {number} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLivenessTransaction(transactionId: number, options?: any): AxiosPromise<LivenessTransaction> {
-            return localVarFp.getLivenessTransaction(transactionId, options).then((request) => request(axios, basePath));
-        },
-        /**
-         * 
-         * @summary metadata
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessMetadata(transactionId: number, options?: any): AxiosPromise<{ [key: string]: object; }> {
-            return localVarFp.livenessMetadata(transactionId, options).then((request) => request(axios, basePath));
-        },
-        /**
-         * 
-         * @summary portrait
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessPortrait(transactionId: number, options?: any): AxiosPromise<any> {
-            return localVarFp.livenessPortrait(transactionId, options).then((request) => request(axios, basePath));
-        },
-        /**
-         * 
-         * @summary video
-         * @param {number} transactionId ID of the current liveness transaction.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        livenessVideo(transactionId: number, options?: any): AxiosPromise<any> {
-            return localVarFp.livenessVideo(transactionId, options).then((request) => request(axios, basePath));
+        getLivenessTransactionInfo(transactionId: number, options?: any): AxiosPromise<TransactionInfo> {
+            return localVarFp.getLivenessTransactionInfo(transactionId, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -292,49 +118,13 @@ export const Liveness20ApiFactory = function (configuration?: Configuration, bas
 export class Liveness20Api extends BaseAPI {
     /**
      * 
-     * @summary liveness
-     * @param {number} transactionId ID of the current liveness transaction.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof Liveness20Api
-     */
-    public getLivenessTransaction(transactionId: number, options?: AxiosRequestConfig) {
-        return Liveness20ApiFp(this.configuration).getLivenessTransaction(transactionId, options).then((request) => request(this.axios, this.basePath));
-    }
-
-    /**
-     * 
-     * @summary metadata
-     * @param {number} transactionId ID of the current liveness transaction.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof Liveness20Api
-     */
-    public livenessMetadata(transactionId: number, options?: AxiosRequestConfig) {
-        return Liveness20ApiFp(this.configuration).livenessMetadata(transactionId, options).then((request) => request(this.axios, this.basePath));
-    }
-
-    /**
-     * 
-     * @summary portrait
-     * @param {number} transactionId ID of the current liveness transaction.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof Liveness20Api
-     */
-    public livenessPortrait(transactionId: number, options?: AxiosRequestConfig) {
-        return Liveness20ApiFp(this.configuration).livenessPortrait(transactionId, options).then((request) => request(this.axios, this.basePath));
-    }
-
-    /**
-     * 
-     * @summary video
+     * @summary Liveness assessment
      * @param {number} transactionId ID of the current liveness transaction.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof Liveness20Api
      */
-    public livenessVideo(transactionId: number, options?: AxiosRequestConfig) {
-        return Liveness20ApiFp(this.configuration).livenessVideo(transactionId, options).then((request) => request(this.axios, this.basePath));
+    public getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig) {
+        return Liveness20ApiFp(this.configuration).getLivenessTransactionInfo(transactionId, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/src/api/matching-api.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the OpenAPI document: 5.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -40,9 +40,9 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
     return {
         /**
          * 
-         * @summary Detect facial coordinates
+         * @summary Detect face, evaluate attributes, assess the portrait quality
          * @param {DetectRequest} detectRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -81,9 +81,9 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
+         * @summary Compare faces in all combinations
          * @param {MatchRequest} matchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -124,7 +124,7 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
          * 
          * @summary Match and Search in one request
          * @param {MatchAndSearchRequest} matchAndSearchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -173,9 +173,9 @@ export const MatchingApiFp = function(configuration?: Configuration) {
     return {
         /**
          * 
-         * @summary Detect facial coordinates
+         * @summary Detect face, evaluate attributes, assess the portrait quality
          * @param {DetectRequest} detectRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -185,9 +185,9 @@ export const MatchingApiFp = function(configuration?: Configuration) {
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
+         * @summary Compare faces in all combinations
          * @param {MatchRequest} matchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -199,7 +199,7 @@ export const MatchingApiFp = function(configuration?: Configuration) {
          * 
          * @summary Match and Search in one request
          * @param {MatchAndSearchRequest} matchAndSearchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -219,9 +219,9 @@ export const MatchingApiFactory = function (configuration?: Configuration, baseP
     return {
         /**
          * 
-         * @summary Detect facial coordinates
+         * @summary Detect face, evaluate attributes, assess the portrait quality
          * @param {DetectRequest} detectRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -230,9 +230,9 @@ export const MatchingApiFactory = function (configuration?: Configuration, baseP
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
+         * @summary Compare faces in all combinations
          * @param {MatchRequest} matchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -243,7 +243,7 @@ export const MatchingApiFactory = function (configuration?: Configuration, baseP
          * 
          * @summary Match and Search in one request
          * @param {MatchAndSearchRequest} matchAndSearchRequest 
-         * @param {string} [xRequestID] 
+         * @param {string} [xRequestID] Request header label.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -262,9 +262,9 @@ export const MatchingApiFactory = function (configuration?: Configuration, baseP
 export class MatchingApi extends BaseAPI {
     /**
      * 
-     * @summary Detect facial coordinates
+     * @summary Detect face, evaluate attributes, assess the portrait quality
      * @param {DetectRequest} detectRequest 
-     * @param {string} [xRequestID] 
+     * @param {string} [xRequestID] Request header label.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MatchingApi
@@ -275,9 +275,9 @@ export class MatchingApi extends BaseAPI {
 
     /**
      * 
-     * @summary Compare provided face images in all combinations and return the similarity score for each pair.
+     * @summary Compare faces in all combinations
      * @param {MatchRequest} matchRequest 
-     * @param {string} [xRequestID] 
+     * @param {string} [xRequestID] Request header label.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MatchingApi
@@ -290,7 +290,7 @@ export class MatchingApi extends BaseAPI {
      * 
      * @summary Match and Search in one request
      * @param {MatchAndSearchRequest} matchAndSearchRequest 
-     * @param {string} [xRequestID] 
+     * @param {string} [xRequestID] Request header label.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MatchingApi