@regulaforensics/facesdk-webclient 4.1.3 → 4.1.5

package/src/api/matching-api.ts

@@ -25,6 +25,10 @@ import { DetectRequest } from '../models';
 // @ts-ignore
 import { DetectResponse } from '../models';
 // @ts-ignore
+import { MatchAndSearchRequest } from '../models';
+// @ts-ignore
+import { MatchAndSearchResponse } from '../models';
+// @ts-ignore
 import { MatchRequest } from '../models';
 // @ts-ignore
 import { MatchResponse } from '../models';
@@ -38,10 +42,11 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
          * 
          * @summary Detect facial coordinates
          * @param {DetectRequest} detectRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        detect: async (detectRequest: DetectRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        detect: async (detectRequest: DetectRequest, xRequestID?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'detectRequest' is not null or undefined
             assertParamExists('detect', 'detectRequest', detectRequest)
             const localVarPath = `/api/detect`;
@@ -56,6 +61,10 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
+            if (xRequestID !== undefined && xRequestID !== null) {
+                localVarHeaderParameter['X-RequestID'] = String(xRequestID);
+            }
+
 
     
             localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -72,12 +81,13 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return similarity score for each pair.
+         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
          * @param {MatchRequest} matchRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        match: async (matchRequest: MatchRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        match: async (matchRequest: MatchRequest, xRequestID?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'matchRequest' is not null or undefined
             assertParamExists('match', 'matchRequest', matchRequest)
             const localVarPath = `/api/match`;
@@ -92,6 +102,10 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
+            if (xRequestID !== undefined && xRequestID !== null) {
+                localVarHeaderParameter['X-RequestID'] = String(xRequestID);
+            }
+
 
     
             localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -101,6 +115,47 @@ export const MatchingApiAxiosParamCreator = function (configuration?: Configurat
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
             localVarRequestOptions.data = serializeDataIfNeeded(matchRequest, localVarRequestOptions, configuration)
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Match and Search in one request
+         * @param {MatchAndSearchRequest} matchAndSearchRequest 
+         * @param {string} [xRequestID] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        matchAndSearch: async (matchAndSearchRequest: MatchAndSearchRequest, xRequestID?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'matchAndSearchRequest' is not null or undefined
+            assertParamExists('matchAndSearch', 'matchAndSearchRequest', matchAndSearchRequest)
+            const localVarPath = `/api/match_and_search`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (xRequestID !== undefined && xRequestID !== null) {
+                localVarHeaderParameter['X-RequestID'] = String(xRequestID);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(matchAndSearchRequest, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -120,22 +175,36 @@ export const MatchingApiFp = function(configuration?: Configuration) {
          * 
          * @summary Detect facial coordinates
          * @param {DetectRequest} detectRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async detect(detectRequest: DetectRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetectResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.detect(detectRequest, options);
+        async detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetectResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.detect(detectRequest, xRequestID, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return similarity score for each pair.
+         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
          * @param {MatchRequest} matchRequest 
+         * @param {string} [xRequestID] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async match(matchRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MatchResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.match(matchRequest, xRequestID, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 
+         * @summary Match and Search in one request
+         * @param {MatchAndSearchRequest} matchAndSearchRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async match(matchRequest: MatchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MatchResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.match(matchRequest, options);
+        async matchAndSearch(matchAndSearchRequest: MatchAndSearchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MatchAndSearchResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.matchAndSearch(matchAndSearchRequest, xRequestID, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -152,21 +221,34 @@ export const MatchingApiFactory = function (configuration?: Configuration, baseP
          * 
          * @summary Detect facial coordinates
          * @param {DetectRequest} detectRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        detect(detectRequest: DetectRequest, options?: any): AxiosPromise<DetectResponse> {
-            return localVarFp.detect(detectRequest, options).then((request) => request(axios, basePath));
+        detect(detectRequest: DetectRequest, xRequestID?: string, options?: any): AxiosPromise<DetectResponse> {
+            return localVarFp.detect(detectRequest, xRequestID, options).then((request) => request(axios, basePath));
         },
         /**
          * 
-         * @summary Compare provided face images in all combinations and return similarity score for each pair.
+         * @summary Compare provided face images in all combinations and return the similarity score for each pair.
          * @param {MatchRequest} matchRequest 
+         * @param {string} [xRequestID] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        match(matchRequest: MatchRequest, options?: any): AxiosPromise<MatchResponse> {
-            return localVarFp.match(matchRequest, options).then((request) => request(axios, basePath));
+        match(matchRequest: MatchRequest, xRequestID?: string, options?: any): AxiosPromise<MatchResponse> {
+            return localVarFp.match(matchRequest, xRequestID, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Match and Search in one request
+         * @param {MatchAndSearchRequest} matchAndSearchRequest 
+         * @param {string} [xRequestID] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        matchAndSearch(matchAndSearchRequest: MatchAndSearchRequest, xRequestID?: string, options?: any): AxiosPromise<MatchAndSearchResponse> {
+            return localVarFp.matchAndSearch(matchAndSearchRequest, xRequestID, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -182,23 +264,38 @@ export class MatchingApi extends BaseAPI {
      * 
      * @summary Detect facial coordinates
      * @param {DetectRequest} detectRequest 
+     * @param {string} [xRequestID] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MatchingApi
      */
-    public detect(detectRequest: DetectRequest, options?: AxiosRequestConfig) {
-        return MatchingApiFp(this.configuration).detect(detectRequest, options).then((request) => request(this.axios, this.basePath));
+    public detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig) {
+        return MatchingApiFp(this.configuration).detect(detectRequest, xRequestID, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
      * 
-     * @summary Compare provided face images in all combinations and return similarity score for each pair.
+     * @summary Compare provided face images in all combinations and return the similarity score for each pair.
      * @param {MatchRequest} matchRequest 
+     * @param {string} [xRequestID] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MatchingApi
+     */
+    public match(matchRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig) {
+        return MatchingApiFp(this.configuration).match(matchRequest, xRequestID, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Match and Search in one request
+     * @param {MatchAndSearchRequest} matchAndSearchRequest 
+     * @param {string} [xRequestID] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MatchingApi
      */
-    public match(matchRequest: MatchRequest, options?: AxiosRequestConfig) {
-        return MatchingApiFp(this.configuration).match(matchRequest, options).then((request) => request(this.axios, this.basePath));
+    public matchAndSearch(matchAndSearchRequest: MatchAndSearchRequest, xRequestID?: string, options?: AxiosRequestConfig) {
+        return MatchingApiFp(this.configuration).matchAndSearch(matchAndSearchRequest, xRequestID, options).then((request) => request(this.axios, this.basePath));
     }
 }