@regulaforensics/facesdk-webclient 3.1.0 → 4.1.0

package/src/models/group-to-create.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.
+ */
+
+
+
+/**
+ * Request body of the group to create data, includes name and metadata.
+ * @export
+ * @interface GroupToCreate
+ */
+export interface GroupToCreate {
+    /**
+     * Group to create name.
+     * @type {string}
+     * @memberof GroupToCreate
+     */
+    'name'?: string;
+    /**
+     * A free-form object containing group\'s extended attributes.
+     * @type {{ [key: string]: object; }}
+     * @memberof GroupToCreate
+     */
+    'metadata'?: { [key: string]: object; };
+}
+

package/src/models/group.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 { GroupAllOf } from './group-all-of';
+import { GroupToCreate } from './group-to-create';
+
+/**
+ * @type Group
+ * @export
+ */
+export type Group = GroupAllOf & GroupToCreate;
+
+

package/src/models/image-fields-image.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 { ImageData } from './image-data';
+
+/**
+ * The uploaded image.
+ * @export
+ * @interface ImageFieldsImage
+ */
+export interface ImageFieldsImage {
+    /**
+     * The original media type of the uploaded image.
+     * @type {string}
+     * @memberof ImageFieldsImage
+     */
+    'content_type'?: string;
+    /**
+     * 
+     * @type {ImageData}
+     * @memberof ImageFieldsImage
+     */
+    'content'?: ImageData;
+}
+

package/src/models/image-fields.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 { ImageFieldsImage } from './image-fields-image';
+
+/**
+ * Image in the request data, includes image and content_type.
+ * @export
+ * @interface ImageFields
+ */
+export interface ImageFields {
+    /**
+     * 
+     * @type {ImageFieldsImage}
+     * @memberof ImageFields
+     */
+    'image'?: ImageFieldsImage;
+}
+

package/src/models/image-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 { Image } from './image';
+
+/**
+ * Image page.
+ * @export
+ * @interface ImagePageAllOf
+ */
+export interface ImagePageAllOf {
+    /**
+     * 
+     * @type {Array<Image>}
+     * @memberof ImagePageAllOf
+     */
+    'items'?: Array<Image>;
+}
+

package/src/models/image-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 { Image } from './image';
+import { ImagePageAllOf } from './image-page-all-of';
+import { Page } from './page';
+
+/**
+ * @type ImagePage
+ * @export
+ */
+export type ImagePage = ImagePageAllOf & Page;
+
+

package/src/models/image-source.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).
@@ -15,17 +15,20 @@
 
 
 /**
- * Face photo image source
+ * Face photo image source.
  * @export
  * @enum {string}
  */
-export enum ImageSource {
-    DOCUMENT_PRINTED = 1,
-    DOCUMENT_RFID = 2,
-    LIVE = 3,
-    DOCUMENT_WITH_LIVE = 4,
-    EXTERNAL = 5
-}
+
+export const ImageSource = {
+    DOCUMENT_PRINTED: 1,
+    DOCUMENT_RFID: 2,
+    LIVE: 3,
+    DOCUMENT_WITH_LIVE: 4,
+    EXTERNAL: 5
+} as const;
+
+export type ImageSource = typeof ImageSource[keyof typeof ImageSource];
 
 
 

package/src/models/image.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+
+/**
+ * Image in the response.
+ * @export
+ * @interface Image
+ */
+export interface Image {
+    /**
+     * Response image ID.
+     * @type {number}
+     * @memberof Image
+     */
+    'id'?: number;
+    /**
+     * The original media type of the returned image.
+     * @type {string}
+     * @memberof Image
+     */
+    'content_type'?: string;
+    /**
+     * The returned image creation date.
+     * @type {string}
+     * @memberof Image
+     */
+    'created_at'?: string;
+    /**
+     * The returned image S3 path.
+     * @type {string}
+     * @memberof Image
+     */
+    'path'?: string;
+    /**
+     * The returned image URL.
+     * @type {string}
+     * @memberof Image
+     */
+    'url'?: string;
+}
+

package/src/models/index.ts

@@ -1,15 +1,54 @@
-export * from './detect-request.js';
-export * from './detect-response.js';
-export * from './detect-response-all-of.js';
-export * from './detect-result.js';
-export * from './detection.js';
-export * from './detection-face.js';
-export * from './face-sdkresult.js';
-export * from './face-sdkresult-code.js';
-export * from './image-source.js';
-export * from './match-image.js';
-export * from './match-image-detection.js';
-export * from './match-image-result.js';
-export * from './match-request.js';
-export * from './match-response.js';
-export * from './match-response-all-of.js';
+export * from './crop';
+export * from './detect-request';
+export * from './detect-response';
+export * from './detect-response-all-of';
+export * from './detect-result';
+export * from './detection';
+export * from './detection-face';
+export * from './detection-quality';
+export * from './face-align-type-quality';
+export * from './face-image-quality-groups';
+export * from './face-quality-config-name';
+export * from './face-quality-scenarios';
+export * from './face-quality-status';
+export * from './face-sdkresult';
+export * from './face-sdkresult-code';
+export * from './group';
+export * from './group-all-of';
+export * from './group-page';
+export * from './group-page-all-of';
+export * from './group-to-create';
+export * from './image';
+export * from './image-fields';
+export * from './image-fields-image';
+export * from './image-page';
+export * from './image-page-all-of';
+export * from './image-source';
+export * from './match-image';
+export * from './match-image-detection';
+export * from './match-image-result';
+export * from './match-request';
+export * from './match-response';
+export * from './match-response-all-of';
+export * from './operation-log';
+export * from './output-image-params';
+export * from './page';
+export * from './person';
+export * from './person-all-of';
+export * from './person-fields';
+export * from './persons-page';
+export * from './persons-page-all-of';
+export * from './process-param';
+export * from './quality-config';
+export * from './quality-detail';
+export * from './quality-details-groups';
+export * from './quality-request';
+export * from './recognize-image';
+export * from './recognize-image-all-of';
+export * from './search-person';
+export * from './search-person-all-of';
+export * from './search-request';
+export * from './search-request-all-of';
+export * from './search-result';
+export * from './search-result-all-of';
+export * from './update-group';

package/src/models/match-image-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).
@@ -27,19 +27,18 @@ export interface MatchImageDetection {
      * @type {Array<DetectionFace>}
      * @memberof MatchImageDetection
      */
-    faces?: Array<DetectionFace>;
+    'faces'?: Array<DetectionFace>;
     /**
-     * Image index used to identify input photos between themselves. If not specified, than input list index is used
+     * Image index used to identify input photos between themselves. If not specified, than input list index is used.
      * @type {number}
      * @memberof MatchImageDetection
      */
-    imageIndex: number;
+    'imageIndex': number;
     /**
      * 
      * @type {FaceSDKResultCode}
      * @memberof MatchImageDetection
      */
-    status: FaceSDKResultCode;
+    'status': FaceSDKResultCode;
 }
 
-

package/src/models/match-image-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).
@@ -22,53 +22,52 @@ import { FaceSDKResultCode } from './face-sdkresult-code';
  */
 export interface MatchImageResult {
     /**
-     * Image index used to identify input photos between themselves. If not specified, than input list index is used
+     * Image index used to identify input photos between themselves. If not specified, than input list index is used.
      * @type {number}
      * @memberof MatchImageResult
      */
-    firstIndex: number;
+    'firstIndex': number;
     /**
      * Faces index used to identify faces in scope of one photo.
      * @type {number}
      * @memberof MatchImageResult
      */
-    firstFaceIndex?: number;
+    'firstFaceIndex'?: number;
     /**
-     * Image index used to identify input photos between themselves. If not specified, than input list index is used
+     * Image index used to identify input photos between themselves. If not specified, than input list index is used.
      * @type {number}
      * @memberof MatchImageResult
      */
-    secondIndex: number;
+    'secondIndex': number;
     /**
      * Faces index used to identify faces in scope of one photo.
      * @type {number}
      * @memberof MatchImageResult
      */
-    secondFaceIndex?: number;
+    'secondFaceIndex'?: number;
     /**
      * 
      * @type {number}
      * @memberof MatchImageResult
      */
-    score?: number;
+    'score'?: number;
     /**
      * 
      * @type {number}
      * @memberof MatchImageResult
      */
-    similarity?: number;
+    'similarity'?: number;
     /**
      * 
      * @type {FaceSDKResultCode}
      * @memberof MatchImageResult
      */
-    errorCode?: FaceSDKResultCode;
+    'errorCode'?: FaceSDKResultCode;
     /**
      * 
      * @type {string}
      * @memberof MatchImageResult
      */
-    errorMsg?: string;
+    'errorMsg'?: string;
 }
 
-

package/src/models/match-image.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).
@@ -23,23 +23,22 @@ import { ImageData } from './image-data';
  */
 export interface MatchImage {
     /**
-     * Image index used to identify input photos between themselves. If not specified, than input list index is used
+     * Image index used to identify input photos between themselves. If not specified, than input list index is used.
      * @type {number}
      * @memberof MatchImage
      */
-    index?: number;
+    'index'?: number;
     /**
      * 
      * @type {ImageSource}
      * @memberof MatchImage
      */
-    type?: ImageSource;
+    'type'?: ImageSource;
     /**
      * 
      * @type {ImageData}
      * @memberof MatchImage
      */
-    data: ImageData;
+    'data': ImageData;
 }
 
-

package/src/models/match-request.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).
@@ -21,18 +21,23 @@ import { MatchImage } from './match-image';
  * @interface MatchRequest
  */
 export interface MatchRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof MatchRequest
+     */
+    'tag'?: string;
     /**
      * 
      * @type {boolean}
      * @memberof MatchRequest
      */
-    thumbnails?: boolean;
+    'thumbnails'?: boolean;
     /**
      * 
      * @type {Array<MatchImage>}
      * @memberof MatchRequest
      */
-    images: Array<MatchImage>;
+    'images': Array<MatchImage>;
 }
 
-

package/src/models/match-response-all-of.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).
@@ -27,13 +27,12 @@ export interface MatchResponseAllOf {
      * @type {Array<MatchImageResult>}
      * @memberof MatchResponseAllOf
      */
-    results?: Array<MatchImageResult>;
+    'results'?: Array<MatchImageResult>;
     /**
      * 
      * @type {Array<MatchImageDetection>}
      * @memberof MatchResponseAllOf
      */
-    detections?: Array<MatchImageDetection>;
+    'detections'?: Array<MatchImageDetection>;
 }
 
-

package/src/models/match-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).
@@ -26,4 +26,3 @@ import { MatchResponseAllOf } from './match-response-all-of';
 export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
 
 
-

package/src/models/operation-log.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface OperationLog
+ */
+export interface OperationLog {
+    /**
+     * 
+     * @type {number}
+     * @memberof OperationLog
+     */
+    'status_code'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OperationLog
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OperationLog
+     */
+    'msg'?: string;
+}
+

package/src/models/output-image-params.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 { Crop } from './crop';
+
+/**
+ * Whether to process the uploaded image according to the indicated settings.
+ * @export
+ * @interface OutputImageParams
+ */
+export interface OutputImageParams {
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof OutputImageParams
+     */
+    'backgroundColor'?: Array<number>;
+    /**
+     * 
+     * @type {Crop}
+     * @memberof OutputImageParams
+     */
+    'crop'?: Crop;
+}
+