@regulaforensics/facesdk-webclient 5.2.3 → 5.2.5

package/src/models/image-source.ts

@@ -1,35 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
- * @export
- * @enum {string}
- */
-
-export const ImageSource = {
-    DOCUMENT_PRINTED: 1,
-    DOCUMENT_RFID: 2,
-    LIVE: 3,
-    DOCUMENT_WITH_LIVE: 4,
-    EXTERNAL: 5,
-    GHOST: 6
-} as const;
-
-export type ImageSource = typeof ImageSource[keyof typeof ImageSource];
-
-
-

package/src/models/image.ts

@@ -1,66 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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. The list is sorted by decreasing ID value.
-     * @type {string}
-     * @memberof Image
-     */
-    'id'?: string;
-    /**
-     * Original media type of the returned image.
-     * @type {string}
-     * @memberof Image
-     */
-    'contentType'?: string;
-    /**
-     * Returned image creation date.
-     * @type {string}
-     * @memberof Image
-     */
-    'createdAt'?: string;
-    /**
-     * Returned image update date.
-     * @type {string}
-     * @memberof Image
-     */
-    'updatedAt'?: string;
-    /**
-     * Returned image path.
-     * @type {string}
-     * @memberof Image
-     */
-    'path'?: string;
-    /**
-     * Returned image URL.
-     * @type {string}
-     * @memberof Image
-     */
-    'url'?: string;
-    /**
-     * A free-form object containing person\'s extended attributes.
-     * @type {{ [key: string]: object; }}
-     * @memberof Image
-     */
-    'metadata'?: { [key: string]: object; };
-}
-

package/src/models/index.ts

@@ -1,72 +0,0 @@
-export * from './crop';
-export * from './detect-request';
-export * from './detect-request-attributes';
-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-attribute';
-export * from './face-image-quality-align-type';
-export * from './face-image-quality-groups';
-export * from './face-image-quality-groups-strings';
-export * from './face-image-quality-status';
-export * from './face-quality-config-name';
-export * from './face-quality-scenarios';
-export * from './face-sdkresult';
-export * from './face-sdkresult-code';
-export * from './faces-response';
-export * from './faces-response-all-of';
-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-and-search-request';
-export * from './match-and-search-request-all-of';
-export * from './match-and-search-request-all-of-images';
-export * from './match-and-search-response';
-export * from './match-and-search-response-all-of';
-export * from './match-and-search-response-all-of-detections';
-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-created-response';
-export * from './person-fields';
-export * from './person-with-images';
-export * from './person-with-images-all-of';
-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 './resize-options';
-export * from './search-bad-params';
-export * from './search-detection';
-export * from './search-parameters';
-export * from './search-parameters-create-person';
-export * from './search-person';
-export * from './search-person-all-of';
-export * from './search-request';
-export * from './search-result';
-export * from './transaction-info';
-export * from './update-group';

package/src/models/liveness-transaction.ts

@@ -1,78 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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: 4.1.3
- * 
- *
- * 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 LivenessTransaction
- */
-export interface LivenessTransaction {
-    /**
-     * 
-     * @type {number}
-     * @memberof LivenessTransaction
-     */
-    'code'?: number;
-    /**
-     * A free-form object containing additional transaction attributes.
-     * @type {{ [key: string]: object; }}
-     * @memberof LivenessTransaction
-     */
-    'config'?: { [key: string]: object; };
-    /**
-     * 
-     * @type {number}
-     * @memberof LivenessTransaction
-     */
-    'elapsed'?: number;
-    /**
-     * URL for portrait image
-     * @type {string}
-     * @memberof LivenessTransaction
-     */
-    'portrait'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof LivenessTransaction
-     */
-    'sessionId'?: string;
-    /**
-     * Whether the liveness detection is confirmed (0) or not (1)
-     * @type {number}
-     * @memberof LivenessTransaction
-     */
-    'status'?: number;
-    /**
-     * 
-     * @type {string}
-     * @memberof LivenessTransaction
-     */
-    'transactionId'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof LivenessTransaction
-     */
-    'video'?: string;
-    /**
-     * A free-form object containing the request information (server time, client IP, etc.).
-     * @type {{ [key: string]: object; }}
-     * @memberof LivenessTransaction
-     */
-    'metadata'?: { [key: string]: object; };
-}
-

package/src/models/match-and-search-request-all-of-images.ts

@@ -1,38 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { ImageSource } from './image-source';
-import { ImageData } from './image-data';
-
-/**
- * 
- * @export
- * @interface MatchAndSearchRequestAllOfImages
- */
-export interface MatchAndSearchRequestAllOfImages {
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof MatchAndSearchRequestAllOfImages
-     */
-    'content'?: ImageData;
-    /**
-     * 
-     * @type {ImageSource}
-     * @memberof MatchAndSearchRequestAllOfImages
-     */
-    'type'?: ImageSource;
-}
-

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

@@ -1,37 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { MatchAndSearchRequestAllOfImages } from './match-and-search-request-all-of-images';
-
-/**
- * 
- * @export
- * @interface MatchAndSearchRequestAllOf
- */
-export interface MatchAndSearchRequestAllOf {
-    /**
-     * Session identificator.
-     * @type {string}
-     * @memberof MatchAndSearchRequestAllOf
-     */
-    'tag'?: string;
-    /**
-     * Array of Person images.
-     * @type {Array<MatchAndSearchRequestAllOfImages>}
-     * @memberof MatchAndSearchRequestAllOf
-     */
-    'images'?: Array<MatchAndSearchRequestAllOfImages>;
-}
-

package/src/models/match-and-search-request.ts

@@ -1,27 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { MatchAndSearchRequestAllOf } from './match-and-search-request-all-of';
-import { MatchAndSearchRequestAllOfImages } from './match-and-search-request-all-of-images';
-import { SearchParameters } from './search-parameters';
-import { SearchParametersCreatePerson } from './search-parameters-create-person';
-
-/**
- * @type MatchAndSearchRequest
- * @export
- */
-export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameters;
-
-

package/src/models/match-and-search-response-all-of-detections.ts

@@ -1,44 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { FaceSDKResultCode } from './face-sdkresult-code';
-import { FacesResponse } from './faces-response';
-
-/**
- * 
- * @export
- * @interface MatchAndSearchResponseAllOfDetections
- */
-export interface MatchAndSearchResponseAllOfDetections {
-    /**
-     * 
-     * @type {Array<FacesResponse>}
-     * @memberof MatchAndSearchResponseAllOfDetections
-     */
-    'faces'?: Array<FacesResponse>;
-    /**
-     * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
-     * @type {number}
-     * @memberof MatchAndSearchResponseAllOfDetections
-     */
-    'imageIndex'?: number;
-    /**
-     * 
-     * @type {FaceSDKResultCode}
-     * @memberof MatchAndSearchResponseAllOfDetections
-     */
-    'status'?: FaceSDKResultCode;
-}
-

package/src/models/match-and-search-response-all-of.ts

@@ -1,50 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { MatchAndSearchResponseAllOfDetections } from './match-and-search-response-all-of-detections';
-import { MatchImageResult } from './match-image-result';
-
-/**
- * 
- * @export
- * @interface MatchAndSearchResponseAllOf
- */
-export interface MatchAndSearchResponseAllOf {
-    /**
-     * 
-     * @type {Array<MatchImageResult>}
-     * @memberof MatchAndSearchResponseAllOf
-     */
-    'results'?: Array<MatchImageResult>;
-    /**
-     * 
-     * @type {number}
-     * @memberof MatchAndSearchResponseAllOf
-     */
-    'elapsedTime'?: number;
-    /**
-     * A free-form object containing person\'s extended attributes.
-     * @type {{ [key: string]: object; }}
-     * @memberof MatchAndSearchResponseAllOf
-     */
-    'metadata'?: { [key: string]: object; };
-    /**
-     * 
-     * @type {Array<MatchAndSearchResponseAllOfDetections>}
-     * @memberof MatchAndSearchResponseAllOf
-     */
-    'detections'?: Array<MatchAndSearchResponseAllOfDetections>;
-}
-

package/src/models/match-and-search-response.ts

@@ -1,28 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { FaceSDKResult } from './face-sdkresult';
-import { FaceSDKResultCode } from './face-sdkresult-code';
-import { MatchAndSearchResponseAllOf } from './match-and-search-response-all-of';
-import { MatchAndSearchResponseAllOfDetections } from './match-and-search-response-all-of-detections';
-import { MatchImageResult } from './match-image-result';
-
-/**
- * @type MatchAndSearchResponse
- * @export
- */
-export type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf;
-
-

package/src/models/match-image-detection.ts

@@ -1,44 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { DetectionFace } from './detection-face';
-import { FaceSDKResultCode } from './face-sdkresult-code';
-
-/**
- * 
- * @export
- * @interface MatchImageDetection
- */
-export interface MatchImageDetection {
-    /**
-     * The array of detected faces.
-     * @type {Array<DetectionFace>}
-     * @memberof MatchImageDetection
-     */
-    'faces'?: Array<DetectionFace>;
-    /**
-     * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
-     * @type {number}
-     * @memberof MatchImageDetection
-     */
-    'imageIndex': number;
-    /**
-     * 
-     * @type {FaceSDKResultCode}
-     * @memberof MatchImageDetection
-     */
-    'status': FaceSDKResultCode;
-}
-

package/src/models/match-image-result.ts

@@ -1,73 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { ImageSource } from './image-source';
-
-/**
- * 
- * @export
- * @interface MatchImageResult
- */
-export interface MatchImageResult {
-    /**
-     * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'firstIndex': number;
-    /**
-     * The detected face index number.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'firstFaceIndex'?: number;
-    /**
-     * 
-     * @type {ImageSource}
-     * @memberof MatchImageResult
-     */
-    'first'?: ImageSource;
-    /**
-     * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'secondIndex': number;
-    /**
-     * The detected face index number.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'secondFaceIndex'?: number;
-    /**
-     * 
-     * @type {ImageSource}
-     * @memberof MatchImageResult
-     */
-    'second'?: ImageSource;
-    /**
-     * A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'score'?: number;
-    /**
-     * The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical.
-     * @type {number}
-     * @memberof MatchImageResult
-     */
-    'similarity'?: number;
-}
-

package/src/models/match-image.ts

@@ -1,50 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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.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 { ImageSource } from './image-source';
-import { ImageData } from './image-data';
-
-/**
- * 
- * @export
- * @interface MatchImage
- */
-export interface MatchImage {
-    /**
-     * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
-     * @type {number}
-     * @memberof MatchImage
-     */
-    'index'?: number;
-    /**
-     * 
-     * @type {ImageSource}
-     * @memberof MatchImage
-     */
-    'type'?: ImageSource;
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof MatchImage
-     */
-    'data': ImageData;
-    /**
-     * Whether to detect all faces in the image. If set to false, only the most central face is detected.
-     * @type {boolean}
-     * @memberof MatchImage
-     */
-    'detectAll'?: boolean;
-}
-