@regulaforensics/facesdk-webclient 5.1.1 → 5.2.0

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: 5.1.0
+ * 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