@regulaforensics/facesdk-webclient 5.2.2 → 5.2.3

package/dist/cjs-es5/api/liveness20-api.js

@@ -90,7 +90,7 @@ exports.Liveness20ApiAxiosParamCreator = function (configuration) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -134,7 +134,7 @@ exports.Liveness20ApiFp = function (configuration) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -163,7 +163,7 @@ exports.Liveness20ApiFactory = function (configuration, basePath, axios) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -186,7 +186,7 @@ var Liveness20Api = /** @class */ (function (_super) {
     /**
      *
      * @summary Liveness assessment
-     * @param {number} transactionId ID of the current liveness transaction.
+     * @param {string} transactionId ID of the current liveness transaction.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof Liveness20Api

package/dist/cjs-es5/models/match-request-output-image-params-crop.js

@@ -0,0 +1,24 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MatchRequestOutputImageParamsCropTypeEnum = void 0;
+exports.MatchRequestOutputImageParamsCropTypeEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3,
+    NUMBER_4: 4
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWF0Y2gtcmVxdWVzdC1vdXRwdXQtaW1hZ2UtcGFyYW1zLWNyb3AuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWxzL21hdGNoLXJlcXVlc3Qtb3V0cHV0LWltYWdlLXBhcmFtcy1jcm9wLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxvQkFBb0I7QUFDcEIsb0JBQW9CO0FBQ3BCOzs7Ozs7Ozs7O0dBVUc7OztBQW9DVSxRQUFBLHlDQUF5QyxHQUFHO0lBQ3JELFFBQVEsRUFBRSxDQUFDO0lBQ1gsUUFBUSxFQUFFLENBQUM7SUFDWCxRQUFRLEVBQUUsQ0FBQztJQUNYLFFBQVEsRUFBRSxDQUFDO0lBQ1gsUUFBUSxFQUFFLENBQUM7Q0FDTCxDQUFDIn0=

package/dist/cjs-es5/models/match-request-output-image-params.js

@@ -0,0 +1,16 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWF0Y2gtcmVxdWVzdC1vdXRwdXQtaW1hZ2UtcGFyYW1zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL21vZGVscy9tYXRjaC1yZXF1ZXN0LW91dHB1dC1pbWFnZS1wYXJhbXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9CQUFvQjtBQUNwQixvQkFBb0I7QUFDcEI7Ozs7Ozs7Ozs7R0FVRyJ9

package/dist/esm-es5/api/liveness20-api.js

@@ -87,7 +87,7 @@ export var Liveness20ApiAxiosParamCreator = function (configuration) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -131,7 +131,7 @@ export var Liveness20ApiFp = function (configuration) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -160,7 +160,7 @@ export var Liveness20ApiFactory = function (configuration, basePath, axios) {
         /**
          *
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -183,7 +183,7 @@ var Liveness20Api = /** @class */ (function (_super) {
     /**
      *
      * @summary Liveness assessment
-     * @param {number} transactionId ID of the current liveness transaction.
+     * @param {string} transactionId ID of the current liveness transaction.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof Liveness20Api

package/dist/esm-es5/models/match-request-output-image-params-crop.js

@@ -0,0 +1,21 @@
+/* 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.
+ */
+export var MatchRequestOutputImageParamsCropTypeEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3,
+    NUMBER_4: 4
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWF0Y2gtcmVxdWVzdC1vdXRwdXQtaW1hZ2UtcGFyYW1zLWNyb3AuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWxzL21hdGNoLXJlcXVlc3Qtb3V0cHV0LWltYWdlLXBhcmFtcy1jcm9wLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLG9CQUFvQjtBQUNwQixvQkFBb0I7QUFDcEI7Ozs7Ozs7Ozs7R0FVRztBQW9DSCxNQUFNLENBQUMsSUFBTSx5Q0FBeUMsR0FBRztJQUNyRCxRQUFRLEVBQUUsQ0FBQztJQUNYLFFBQVEsRUFBRSxDQUFDO0lBQ1gsUUFBUSxFQUFFLENBQUM7SUFDWCxRQUFRLEVBQUUsQ0FBQztJQUNYLFFBQVEsRUFBRSxDQUFDO0NBQ0wsQ0FBQyJ9

package/dist/esm-es5/models/match-request-output-image-params.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWF0Y2gtcmVxdWVzdC1vdXRwdXQtaW1hZ2UtcGFyYW1zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL21vZGVscy9tYXRjaC1yZXF1ZXN0LW91dHB1dC1pbWFnZS1wYXJhbXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsb0JBQW9CO0FBQ3BCLG9CQUFvQjtBQUNwQjs7Ozs7Ozs7OztHQVVHIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/facesdk-webclient",
-  "version": "5.2.2",
+  "version": "5.2.3",
   "description": "JS client for facesdk web service",
   "author": "Regula Forensics, Inc.",
   "keywords": [

package/src/api/liveness20-api.ts

@@ -31,11 +31,11 @@ export const Liveness20ApiAxiosParamCreator = function (configuration?: Configur
         /**
          * 
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLivenessTransactionInfo: async (transactionId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getLivenessTransactionInfo: async (transactionId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'transactionId' is not null or undefined
             assertParamExists('getLivenessTransactionInfo', 'transactionId', transactionId)
             const localVarPath = `/api/v2/liveness`;
@@ -78,11 +78,11 @@ export const Liveness20ApiFp = function(configuration?: Configuration) {
         /**
          * 
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionInfo>> {
+        async getLivenessTransactionInfo(transactionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionInfo>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getLivenessTransactionInfo(transactionId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -99,11 +99,11 @@ export const Liveness20ApiFactory = function (configuration?: Configuration, bas
         /**
          * 
          * @summary Liveness assessment
-         * @param {number} transactionId ID of the current liveness transaction.
+         * @param {string} transactionId ID of the current liveness transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLivenessTransactionInfo(transactionId: number, options?: any): AxiosPromise<TransactionInfo> {
+        getLivenessTransactionInfo(transactionId: string, options?: any): AxiosPromise<TransactionInfo> {
             return localVarFp.getLivenessTransactionInfo(transactionId, options).then((request) => request(axios, basePath));
         },
     };
@@ -119,12 +119,12 @@ export class Liveness20Api extends BaseAPI {
     /**
      * 
      * @summary Liveness assessment
-     * @param {number} transactionId ID of the current liveness transaction.
+     * @param {string} transactionId ID of the current liveness transaction.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof Liveness20Api
      */
-    public getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig) {
+    public getLivenessTransactionInfo(transactionId: string, options?: AxiosRequestConfig) {
         return Liveness20ApiFp(this.configuration).getLivenessTransactionInfo(transactionId, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/src/models/image.ts

@@ -22,10 +22,10 @@
 export interface Image {
     /**
      * Response image ID. The list is sorted by decreasing ID value.
-     * @type {number}
+     * @type {string}
      * @memberof Image
      */
-    'id'?: number;
+    'id'?: string;
     /**
      * Original media type of the returned image.
      * @type {string}

package/src/models/match-request-output-image-params-crop.ts

@@ -0,0 +1,59 @@
+/* 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.
+ */
+
+
+
+/**
+ * Whether to return the Base64 of an aligned and cropped portrait in the crop field.
+ * @export
+ * @interface MatchRequestOutputImageParamsCrop
+ */
+export interface MatchRequestOutputImageParamsCrop {
+    /**
+     * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
+     * @type {Array<number>}
+     * @memberof MatchRequestOutputImageParamsCrop
+     */
+    'padColor'?: Array<number>;
+    /**
+     * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
+     * @type {boolean}
+     * @memberof MatchRequestOutputImageParamsCrop
+     */
+    'returnOriginalRect'?: boolean;
+    /**
+     * The resize value in case type matches this value. If it doesn\'t, no resize is done.
+     * @type {Array<number>}
+     * @memberof MatchRequestOutputImageParamsCrop
+     */
+    'size'?: Array<number>;
+    /**
+     * The aspect ratio according to which face alignment is performed during face detection.
+     * @type {number}
+     * @memberof MatchRequestOutputImageParamsCrop
+     */
+    'type'?: MatchRequestOutputImageParamsCropTypeEnum;
+}
+
+export const MatchRequestOutputImageParamsCropTypeEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3,
+    NUMBER_4: 4
+} as const;
+
+export type MatchRequestOutputImageParamsCropTypeEnum = typeof MatchRequestOutputImageParamsCropTypeEnum[keyof typeof MatchRequestOutputImageParamsCropTypeEnum];
+
+

package/src/models/match-request-output-image-params.ts

@@ -0,0 +1,37 @@
+/* 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 { MatchRequestOutputImageParamsCrop } from './match-request-output-image-params-crop';
+
+/**
+ * Whether to process the uploaded image according to the indicated settings.
+ * @export
+ * @interface MatchRequestOutputImageParams
+ */
+export interface MatchRequestOutputImageParams {
+    /**
+     * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
+     * @type {Array<number>}
+     * @memberof MatchRequestOutputImageParams
+     */
+    'backgroundColor'?: Array<number>;
+    /**
+     * 
+     * @type {MatchRequestOutputImageParamsCrop}
+     * @memberof MatchRequestOutputImageParams
+     */
+    'crop'?: MatchRequestOutputImageParamsCrop;
+}
+