@regulaforensics/facesdk-webclient 3.1.0 → 4.1.0

package/src/models/detect-response.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,4 +25,3 @@ import { FaceSDKResultCode } from './face-sdkresult-code';
 export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
 
 
-

package/src/models/detect-result.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,6 +14,7 @@
 
 
 import { Detection } from './detection';
+import { FaceQualityScenarios } from './face-quality-scenarios';
 
 /**
  * 
@@ -26,19 +27,30 @@ export interface DetectResult {
      * @type {Array<Detection>}
      * @memberof DetectResult
      */
-    detections: Array<Detection>;
+    'detections': Array<Detection>;
     /**
      * Internal.
      * @type {number}
      * @memberof DetectResult
      */
-    detectorType?: number;
+    'detectorType'?: number;
     /**
      * Internal.
      * @type {number}
      * @memberof DetectResult
      */
-    landmarksType?: number;
+    'landmarksType'?: number;
+    /**
+     * 
+     * @type {FaceQualityScenarios}
+     * @memberof DetectResult
+     */
+    'scenario'?: FaceQualityScenarios;
+    /**
+     * 
+     * @type {number}
+     * @memberof DetectResult
+     */
+    'timer'?: number;
 }
 
-

package/src/models/detection-face.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,25 +25,24 @@ export interface DetectionFace {
      * @type {number}
      * @memberof DetectionFace
      */
-    faceIndex?: number;
+    'faceIndex'?: number;
     /**
-     * Main coordinates of the detected face (eyes, nose, lips, ears and etc.).
+     * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
      * @type {Array<Array<number>>}
      * @memberof DetectionFace
      */
-    landmarks?: Array<Array<number>>;
+    'landmarks'?: Array<Array<number>>;
     /**
      * Rectangular area of the detected face. First element - X-axis coordinate. Second element - Y-axis coordinate. (X, Y) - left top point. Third element - rectangular width. Fourth element - rectangular height.
      * @type {Array<number>}
      * @memberof DetectionFace
      */
-    roi?: Array<number>;
+    'roi'?: Array<number>;
     /**
-     * Formatted base64 face detection image.
+     * Base64 of the cropped portrait.
      * @type {string}
      * @memberof DetectionFace
      */
-    thumbnail?: string;
+    'thumbnail'?: string;
 }
 
-

package/src/models/detection-quality.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 { FaceQualityConfigName } from './face-quality-config-name';
+import { QualityDetail } from './quality-detail';
+import { QualityDetailsGroups } from './quality-details-groups';
+
+/**
+ * Field for checking the portrait quality. If it is not mentioned, no quality check is performed.
+ * @export
+ * @interface DetectionQuality
+ */
+export interface DetectionQuality {
+    /**
+     * The array of all the non-compliant assessment characteristics.
+     * @type {Array<FaceQualityConfigName>}
+     * @memberof DetectionQuality
+     */
+    'nonCompliant'?: Array<FaceQualityConfigName>;
+    /**
+     * The array of the assessment results for each group of characteristics.
+     * @type {Array<QualityDetailsGroups>}
+     * @memberof DetectionQuality
+     */
+    'detailsGroups'?: Array<QualityDetailsGroups>;
+    /**
+     * The array of the assessment characteristics that were set in the request.
+     * @type {Array<QualityDetail>}
+     * @memberof DetectionQuality
+     */
+    'details'?: Array<QualityDetail>;
+    /**
+     * Returns the estimated portrait quality assessment result, a number from 0 to 1, where 1 is for absolute compliance.
+     * @type {number}
+     * @memberof DetectionQuality
+     */
+    'score'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DetectionQuality
+     */
+    'timer'?: number;
+}
+

package/src/models/detection.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,8 @@
  */
 
 
+import { DetectionQuality } from './detection-quality';
+import { ImageData } from './image-data';
 
 /**
  * 
@@ -20,30 +22,41 @@
  * @interface Detection
  */
 export interface Detection {
+    /**
+     * 
+     * @type {ImageData}
+     * @memberof Detection
+     */
+    'crop'?: ImageData;
     /**
      * 
      * @type {{ [key: string]: object; }}
      * @memberof Detection
      */
-    attributes?: { [key: string]: object; };
+    'attributes'?: { [key: string]: object; };
     /**
-     * Main coordinates of the detected face (eyes, nose, lips, ears and etc.).
+     * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
      * @type {Array<Array<number>>}
      * @memberof Detection
      */
-    landmarks: Array<Array<number>>;
+    'landmarks': Array<Array<number>>;
+    /**
+     * 
+     * @type {DetectionQuality}
+     * @memberof Detection
+     */
+    'quality'?: DetectionQuality;
     /**
      * Rectangular area of the detected face. First element - X-axis coordinate. Second element - Y-axis coordinate. (X, Y) - left top point. Third element - rectangular width. Fourth element - rectangular height.
      * @type {Array<number>}
      * @memberof Detection
      */
-    roi: Array<number>;
+    'roi': Array<number>;
     /**
-     * Formatted base64 face detection image.
+     * Base64 of the cropped portrait.
      * @type {string}
      * @memberof Detection
      */
-    thumbnail?: string;
+    'thumbnail'?: string;
 }
 
-

package/src/models/face-align-type-quality.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+
+
+/**
+ * The aspect ratio according to which alignment is performed.
+ * @export
+ * @enum {string}
+ */
+
+export const FaceAlignTypeQuality = {
+    ALIGN_3x4: 0,
+    ALIGN_4x5: 1,
+    ALIGN_2x3: 2,
+    ALIGN_1x1: 3,
+    ALIGN_7x9: 4
+} as const;
+
+export type FaceAlignTypeQuality = typeof FaceAlignTypeQuality[keyof typeof FaceAlignTypeQuality];
+
+
+

package/src/models/face-image-quality-groups.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const FaceImageQualityGroups = {
+    IMAGE_CHARACTERISTICS: 1,
+    HEAD_SIZE_AND_POSITIONS: 2,
+    FACE_QUALITY: 3,
+    EYES_CHARACTERISTICS: 4,
+    SHADOWS_AND_LIGHTNING: 5,
+    POSE_AND_EXPRESSION: 6,
+    HEAD_OCCLUSION: 8
+} as const;
+
+export type FaceImageQualityGroups = typeof FaceImageQualityGroups[keyof typeof FaceImageQualityGroups];
+
+
+

package/src/models/face-quality-config-name.ts

@@ -0,0 +1,71 @@
+/* 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
+ * @enum {string}
+ */
+
+export const FaceQualityConfigName = {
+    IMAGE_WIDTH: 'ImageWidth',
+    IMAGE_HEIGHT: 'ImageHeight',
+    IMAGE_WIDTH_TO_HEIGHT: 'ImageWidthToHeight',
+    IMAGE_CHANNELS_NUMBER: 'ImageChannelsNumber',
+    FACE_MID_POINT_HORIZONTAL_POSITION: 'FaceMidPointHorizontalPosition',
+    FACE_MID_POINT_VERTICAL_POSITION: 'FaceMidPointVerticalPosition',
+    HEAD_WIDTH_RATIO: 'HeadWidthRatio',
+    HEAD_HEIGHT_RATIO: 'HeadHeightRatio',
+    EYES_DISTANCE: 'EyesDistance',
+    YAW: 'Yaw',
+    PITCH: 'Pitch',
+    ROLL: 'Roll',
+    BLUR_LEVEL: 'BlurLevel',
+    NOISE_LEVEL: 'NoiseLevel',
+    EYE_RIGHT_CLOSED: 'EyeRightClosed',
+    EYE_LEFT_CLOSED: 'EyeLeftClosed',
+    EYE_RIGHT_OCCLUDED: 'EyeRightOccluded',
+    EYE_LEFT_OCCLUDED: 'EyeLeftOccluded',
+    EYES_RED: 'EyesRed',
+    EYE_RIGHT_COVERED_WITH_HAIR: 'EyeRightCoveredWithHair',
+    EYE_LEFT_COVERED_WITH_HAIR: 'EyeLeftCoveredWithHair',
+    OFF_GAZE: 'OffGaze',
+    FACE_DYNAMIC_RANGE: 'FaceDynamicRange',
+    UNNATURAL_SKIN_TONE: 'UnnaturalSkinTone',
+    TOO_DARK: 'TooDark',
+    TOO_LIGHT: 'TooLight',
+    FACE_GLARE: 'FaceGlare',
+    SHADOWS_ON_FACE: 'ShadowsOnFace',
+    DARK_GLASSES: 'DarkGlasses',
+    REFLECTION_ON_GLASSES: 'ReflectionOnGlasses',
+    FRAMES_TOO_HEAVY: 'FramesTooHeavy',
+    FACE_OCCLUDED: 'FaceOccluded',
+    HEAD_COVERING: 'HeadCovering',
+    BACKGROUND_UNIFORMITY: 'BackgroundUniformity',
+    SHADOWS_ON_BACKGROUND: 'ShadowsOnBackground',
+    OTHER_FACES: 'OtherFaces',
+    SHOULDERS_POSE: 'ShouldersPose',
+    EXPRESSION_LEVEL: 'ExpressionLevel',
+    MOUTH_OPEN: 'MouthOpen',
+    CONTACT_LENSES: 'ContactLenses',
+    FOREHEAD_COVERING: 'ForeheadCovering',
+    SMILE: 'Smile'
+} as const;
+
+export type FaceQualityConfigName = typeof FaceQualityConfigName[keyof typeof FaceQualityConfigName];
+
+
+

package/src/models/face-quality-scenarios.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const FaceQualityScenarios = {
+    QUALITY_FULL: 'QualityFull',
+    QUALITY_ICAO: 'QualityICAO',
+    QUALITY_VISA_SCHENGEN: 'QualityVisaSchengen',
+    QUALITY_VISA_USA: 'QualityVisaUSA',
+    CROP_CENTRAL_FACE: 'CropCentralFace',
+    CROP_ALL_FACES: 'CropAllFaces',
+    THUMBNAIL: 'Thumbnail'
+} as const;
+
+export type FaceQualityScenarios = typeof FaceQualityScenarios[keyof typeof FaceQualityScenarios];
+
+
+

package/src/models/face-quality-status.ts

@@ -0,0 +1,32 @@
+/* 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
+ * @enum {string}
+ */
+
+export const FaceQualityStatus = {
+    QUALITY_STATUS_FALSE: 0,
+    QUALITY_STATUS_TRUE: 1,
+    QUALITY_STATUS_UNDETERMINED: 2
+} as const;
+
+export type FaceQualityStatus = typeof FaceQualityStatus[keyof typeof FaceQualityStatus];
+
+
+

package/src/models/face-recognition-result-code.ts

@@ -11,7 +11,3 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-
-import {FaceSDKResultCode} from './face-sdkresult-code.js';
-export import FaceRecognitionResultCode = FaceSDKResultCode;

package/src/models/face-sdkresult-code.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,39 +19,42 @@
  * @export
  * @enum {string}
  */
-export enum FaceSDKResultCode {
-    FACER_OK = 0,
-    FACER_NO_LICENSE = 200,
-    FACER_IS_NOT_INITIALIZED = 201,
-    FACER_COMMAND_IS_NOT_SUPPORTED = 202,
-    FACER_COMMAND_PARAMS_READ_ERROR = 203,
-    FACER_SEARCHER_INDEX_FILE_NOT_EXIST = 204,
-    FACER_SEARCHER_INDEX_FILE_READ_ERROR = 205,
-    FACER_SEARCHER_INDEX_FILE_DECRYPTION_ERROR = 206,
-    FACER_SEARCHER_INDEX_LOAD_ERROR = 207,
-    FACER_SEARCHER_WRONG_DESCRIPTOR_VERSION = 208,
-    FACER_SEARCHER_INDEX_FILE_ENCRYPTION_ERROR = 209,
-    FACER_SEARCHER_INDEX_FILE_SAVE_ERROR = 210,
-    FACER_SEARCHER_IMAGE_DECODE_ERROR = 211,
-    FACER_SEARCHER_ID_EXISTS_IN_INDEX = 212,
-    FACER_SEARCHER_ID_NOT_IN_INDEX = 213,
-    FACER_SEARCHER_NO_FACES = 214,
-    FACER_SEARCHER_DESCRIPTOR_EXTRACTOR_ERROR = 215,
-    FACER_SEARCHER_METADATA_READ_ERROR = 216,
-    FACER_SEARCHER_NO_SEARCH_LICENSE = 217,
-    FACER_SEARCHER_DESCRIPTOR_DECODE_ERROR = 218,
-    FACER_SEARCHER_DESCRIPTOR_WRONG_SIZE = 219,
-    FACER_SEARCHER_ZIP_IMAGE_READ_ERROR = 220,
-    FACER_SEARCHER_ZIP_META_READ_ERROR = 221,
-    FACER_SEARCHER_SIMILAR_PHOTOS_EXIST = 222,
-    FACER_SEARCHER_PERSON_ZIP_READ_ERROR = 223,
-    FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST = 224,
-    FACER_SEARCHER_WRONG_ID = 225,
-    FACER_SEARCHER_ID_EXISTS_IN_DELETED = 226,
-    FACER_VIDEO_DECODE_ERROR = 227,
-    FACER_NOT_ENOUGH_FRAMES = 228,
-    FACER_OUTPUT_IS_NOT_DEFINED = 229
-}
+
+export const FaceSDKResultCode = {
+    FACER_OK: 0,
+    FACER_NO_LICENSE: 200,
+    FACER_IS_NOT_INITIALIZED: 201,
+    FACER_COMMAND_IS_NOT_SUPPORTED: 202,
+    FACER_COMMAND_PARAMS_READ_ERROR: 203,
+    FACER_SEARCHER_INDEX_FILE_NOT_EXIST: 204,
+    FACER_SEARCHER_INDEX_FILE_READ_ERROR: 205,
+    FACER_SEARCHER_INDEX_FILE_DECRYPTION_ERROR: 206,
+    FACER_SEARCHER_INDEX_LOAD_ERROR: 207,
+    FACER_SEARCHER_WRONG_DESCRIPTOR_VERSION: 208,
+    FACER_SEARCHER_INDEX_FILE_ENCRYPTION_ERROR: 209,
+    FACER_SEARCHER_INDEX_FILE_SAVE_ERROR: 210,
+    FACER_SEARCHER_IMAGE_DECODE_ERROR: 211,
+    FACER_SEARCHER_ID_EXISTS_IN_INDEX: 212,
+    FACER_SEARCHER_ID_NOT_IN_INDEX: 213,
+    FACER_SEARCHER_NO_FACES: 214,
+    FACER_SEARCHER_DESCRIPTOR_EXTRACTOR_ERROR: 215,
+    FACER_SEARCHER_METADATA_READ_ERROR: 216,
+    FACER_SEARCHER_NO_SEARCH_LICENSE: 217,
+    FACER_SEARCHER_DESCRIPTOR_DECODE_ERROR: 218,
+    FACER_SEARCHER_DESCRIPTOR_WRONG_SIZE: 219,
+    FACER_SEARCHER_ZIP_IMAGE_READ_ERROR: 220,
+    FACER_SEARCHER_ZIP_META_READ_ERROR: 221,
+    FACER_SEARCHER_SIMILAR_PHOTOS_EXIST: 222,
+    FACER_SEARCHER_PERSON_ZIP_READ_ERROR: 223,
+    FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: 224,
+    FACER_SEARCHER_WRONG_ID: 225,
+    FACER_SEARCHER_ID_EXISTS_IN_DELETED: 226,
+    FACER_VIDEO_DECODE_ERROR: 227,
+    FACER_NOT_ENOUGH_FRAMES: 228,
+    FACER_OUTPUT_IS_NOT_DEFINED: 229
+} as const;
+
+export type FaceSDKResultCode = typeof FaceSDKResultCode[keyof typeof FaceSDKResultCode];
 
 
 

package/src/models/face-sdkresult.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,6 @@ export interface FaceSDKResult {
      * @type {FaceSDKResultCode}
      * @memberof FaceSDKResult
      */
-    code: FaceSDKResultCode;
+    'code': FaceSDKResultCode;
 }
 
-

package/src/models/group-all-of.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.
+ */
+
+
+
+/**
+ * Additional group data in the response, includes id and created_at.
+ * @export
+ * @interface GroupAllOf
+ */
+export interface GroupAllOf {
+    /**
+     * Group ID.
+     * @type {number}
+     * @memberof GroupAllOf
+     */
+    'id'?: number;
+    /**
+     * Group creation date.
+     * @type {string}
+     * @memberof GroupAllOf
+     */
+    'created_at'?: string;
+}
+

package/src/models/group-page-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 { Group } from './group';
+
+/**
+ * 
+ * @export
+ * @interface GroupPageAllOf
+ */
+export interface GroupPageAllOf {
+    /**
+     * The array of Groups that are found during the search.
+     * @type {Array<Group>}
+     * @memberof GroupPageAllOf
+     */
+    'items'?: Array<Group>;
+}
+

package/src/models/group-page.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 { Group } from './group';
+import { GroupPageAllOf } from './group-page-all-of';
+import { Page } from './page';
+
+/**
+ * @type GroupPage
+ * @export
+ */
+export type GroupPage = GroupPageAllOf & Page;
+
+