@regulaforensics/facesdk-webclient 3.1.2 → 4.1.0

package/src/models/process-param.ts

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { FaceQualityScenarios } from './face-quality-scenarios';
+import { OutputImageParams } from './output-image-params';
+import { QualityRequest } from './quality-request';
+
+/**
+ * The processing parameters.
+ * @export
+ * @interface ProcessParam
+ */
+export interface ProcessParam {
+    /**
+     * 
+     * @type {FaceQualityScenarios}
+     * @memberof ProcessParam
+     */
+    'scenario'?: FaceQualityScenarios;
+    /**
+     * Whether to process only the central face on the image (true) or all the faces (false).
+     * @type {boolean}
+     * @memberof ProcessParam
+     */
+    'onlyCentralFace'?: boolean;
+    /**
+     * 
+     * @type {OutputImageParams}
+     * @memberof ProcessParam
+     */
+    'outputImageParams'?: OutputImageParams;
+    /**
+     * 
+     * @type {QualityRequest}
+     * @memberof ProcessParam
+     */
+    'quality'?: QualityRequest;
+}
+

package/src/models/quality-config.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { FaceQualityConfigName } from './face-quality-config-name';
+
+/**
+ * The configuration that defines the list of returned quality check characteristics. For every characteristic, includes name, range, unit.
+ * @export
+ * @interface QualityConfig
+ */
+export interface QualityConfig {
+    /**
+     * 
+     * @type {FaceQualityConfigName}
+     * @memberof QualityConfig
+     */
+    'name'?: FaceQualityConfigName;
+    /**
+     * The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.
+     * @type {Array<number>}
+     * @memberof QualityConfig
+     */
+    'range'?: Array<number>;
+}
+

package/src/models/quality-detail.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { FaceImageQualityGroups } from './face-image-quality-groups';
+import { FaceQualityConfigName } from './face-quality-config-name';
+import { FaceQualityStatus } from './face-quality-status';
+
+/**
+ * 
+ * @export
+ * @interface QualityDetail
+ */
+export interface QualityDetail {
+    /**
+     * 
+     * @type {FaceImageQualityGroups}
+     * @memberof QualityDetail
+     */
+    'groupId'?: FaceImageQualityGroups;
+    /**
+     * 
+     * @type {FaceQualityConfigName}
+     * @memberof QualityDetail
+     */
+    'name'?: FaceQualityConfigName;
+    /**
+     * The range of set values for this characteristic.
+     * @type {Array<number>}
+     * @memberof QualityDetail
+     */
+    'range'?: Array<number>;
+    /**
+     * 
+     * @type {FaceQualityStatus}
+     * @memberof QualityDetail
+     */
+    'status'?: FaceQualityStatus;
+    /**
+     * The assessed value for the characteristic, returned in the set units.
+     * @type {number}
+     * @memberof QualityDetail
+     */
+    'value'?: number;
+}
+

package/src/models/quality-details-groups.ts

@@ -0,0 +1,50 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { FaceImageQualityGroups } from './face-image-quality-groups';
+import { FaceQualityConfigName } from './face-quality-config-name';
+
+/**
+ * 
+ * @export
+ * @interface QualityDetailsGroups
+ */
+export interface QualityDetailsGroups {
+    /**
+     * 
+     * @type {FaceImageQualityGroups}
+     * @memberof QualityDetailsGroups
+     */
+    'groupId'?: FaceImageQualityGroups;
+    /**
+     * 
+     * @type {FaceQualityConfigName}
+     * @memberof QualityDetailsGroups
+     */
+    'name'?: FaceQualityConfigName;
+    /**
+     * The total number of characteristics in the group.
+     * @type {number}
+     * @memberof QualityDetailsGroups
+     */
+    'totalCount'?: number;
+    /**
+     * The number of compliant characteristics in the group.
+     * @type {number}
+     * @memberof QualityDetailsGroups
+     */
+    'compliantCount'?: number;
+}
+

package/src/models/quality-request.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { QualityConfig } from './quality-config';
+
+/**
+ * Whether to perform the portrait quality check.
+ * @export
+ * @interface QualityRequest
+ */
+export interface QualityRequest {
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof QualityRequest
+     */
+    'backgroundMatchColor'?: Array<number>;
+    /**
+     * 
+     * @type {Array<QualityConfig>}
+     * @memberof QualityRequest
+     */
+    'config'?: Array<QualityConfig>;
+}
+

package/src/models/recognize-image-all-of.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * 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 RecognizeImageAllOf
+ */
+export interface RecognizeImageAllOf {
+    /**
+     * The similarity score.
+     * @type {number}
+     * @memberof RecognizeImageAllOf
+     */
+    'similarity'?: number;
+}
+

package/src/models/recognize-image.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { Image } from './image';
+import { RecognizeImageAllOf } from './recognize-image-all-of';
+
+/**
+ * @type RecognizeImage
+ * @export
+ */
+export type RecognizeImage = Image & RecognizeImageAllOf;
+
+

package/src/models/search-person-all-of.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { RecognizeImage } from './recognize-image';
+
+/**
+ * The array of Person images.
+ * @export
+ * @interface SearchPersonAllOf
+ */
+export interface SearchPersonAllOf {
+    /**
+     * 
+     * @type {Array<RecognizeImage>}
+     * @memberof SearchPersonAllOf
+     */
+    'images'?: Array<RecognizeImage>;
+}
+

package/src/models/search-person.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { Person } from './person';
+import { RecognizeImage } from './recognize-image';
+import { SearchPersonAllOf } from './search-person-all-of';
+
+/**
+ * @type SearchPerson
+ * @export
+ */
+export type SearchPerson = Person & SearchPersonAllOf;
+
+

package/src/models/search-request-all-of.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Request search data.
+ * @export
+ * @interface SearchRequestAllOf
+ */
+export interface SearchRequestAllOf {
+    /**
+     * The number of returned Persons limit.
+     * @type {number}
+     * @memberof SearchRequestAllOf
+     */
+    'limit'?: number;
+    /**
+     * Similarity threshold.
+     * @type {number}
+     * @memberof SearchRequestAllOf
+     */
+    'threshold'?: number;
+    /**
+     * The IDs of the groups in which the search is performed.
+     * @type {Array<number>}
+     * @memberof SearchRequestAllOf
+     */
+    'group_ids'?: Array<number>;
+}
+

package/src/models/search-request.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { ImageFields } from './image-fields';
+import { ImageFieldsImage } from './image-fields-image';
+import { SearchRequestAllOf } from './search-request-all-of';
+
+/**
+ * @type SearchRequest
+ * @export
+ */
+export type SearchRequest = ImageFields & SearchRequestAllOf;
+
+

package/src/models/search-result-all-of.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * 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 SearchResultAllOf
+ */
+export interface SearchResultAllOf {
+    /**
+     * The search result code.
+     * @type {number}
+     * @memberof SearchResultAllOf
+     */
+    'code'?: number;
+}
+

package/src/models/search-result.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.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 { RecognizeImage } from './recognize-image';
+import { SearchPerson } from './search-person';
+import { SearchResultAllOf } from './search-result-all-of';
+
+/**
+ * @type SearchResult
+ * @export
+ */
+export type SearchResult = SearchPerson & SearchResultAllOf;
+
+

package/src/models/update-group.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Update group.
+ * @export
+ * @interface UpdateGroup
+ */
+export interface UpdateGroup {
+    /**
+     * Add items.
+     * @type {Array<number>}
+     * @memberof UpdateGroup
+     */
+    'addItems'?: Array<number>;
+    /**
+     * Remove items.
+     * @type {Array<number>}
+     * @memberof UpdateGroup
+     */
+    'removeItems'?: Array<number>;
+}
+

package/update-models.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 docker run --user "$(id -u):$(id -g)" --rm -v "${PWD}:/client" -v "${PWD}/../FaceSDK-web-openapi:/definitions" \
-openapitools/openapi-generator-cli:v5.0.0-beta2 generate -g typescript-axios \
+openapitools/openapi-generator-cli:v5.4.0 generate -g typescript-axios \
 -i /definitions/index.yml -o /client/src -c /client/ts-generator-config.json \
 -t /client/generator-templates || exit 1