diff --git a/src/.openapi-generator/FILES b/src/.openapi-generator/FILES index c5b9c7a8..61c66b1c 100755 --- a/src/.openapi-generator/FILES +++ b/src/.openapi-generator/FILES @@ -1,4 +1,4 @@ -api/default-api.ts +api/healthcheck-api.ts api/process-api.ts api/transaction-api.ts base.ts @@ -26,6 +26,7 @@ models/data-module.ts models/details-optical.ts models/details-rfid.ts models/device-info.ts +models/device-info2.ts models/doc-bar-code-info-all-of.ts models/doc-bar-code-info-fields-list.ts models/doc-bar-code-info.ts diff --git a/src/api/healthcheck-api.ts b/src/api/healthcheck-api.ts new file mode 100644 index 00000000..00e86906 --- /dev/null +++ b/src/api/healthcheck-api.ts @@ -0,0 +1,292 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Regula Document Reader Web API + * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core + * + * The version of the OpenAPI document: 7.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 globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +import { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { DeviceInfo } from '../models'; +// @ts-ignore +import { DeviceInfo2 } from '../models'; +/** + * HealthcheckApi - axios parameter creator + * @export + */ +export const HealthcheckApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Server healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + healthz: async (xRequestID?: string, options: any = {}): Promise => { + const localVarPath = `/api/healthz`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, 'https://example.com'); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (xRequestID !== undefined && xRequestID !== null) { + localVarHeaderParameter['X-RequestID'] = String(xRequestID); + } + + + + const queryParameters = new URLSearchParams(localVarUrlObj.search); + for (const key in localVarQueryParameter) { + queryParameters.set(key, localVarQueryParameter[key]); + } + for (const key in options.query) { + queryParameters.set(key, options.query[key]); + } + localVarUrlObj.search = (new URLSearchParams(queryParameters)).toString(); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Server health check + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + ping: async (xRequestID?: string, options: any = {}): Promise => { + const localVarPath = `/api/ping`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, 'https://example.com'); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (xRequestID !== undefined && xRequestID !== null) { + localVarHeaderParameter['X-RequestID'] = String(xRequestID); + } + + + + const queryParameters = new URLSearchParams(localVarUrlObj.search); + for (const key in localVarQueryParameter) { + queryParameters.set(key, localVarQueryParameter[key]); + } + for (const key in options.query) { + queryParameters.set(key, options.query[key]); + } + localVarUrlObj.search = (new URLSearchParams(queryParameters)).toString(); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, + options: localVarRequestOptions, + }; + }, + /** + * + * @summary License healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + readyz: async (xRequestID?: string, options: any = {}): Promise => { + const localVarPath = `/api/readyz`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, 'https://example.com'); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (xRequestID !== undefined && xRequestID !== null) { + localVarHeaderParameter['X-RequestID'] = String(xRequestID); + } + + + + const queryParameters = new URLSearchParams(localVarUrlObj.search); + for (const key in localVarQueryParameter) { + queryParameters.set(key, localVarQueryParameter[key]); + } + for (const key in options.query) { + queryParameters.set(key, options.query[key]); + } + localVarUrlObj.search = (new URLSearchParams(queryParameters)).toString(); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * HealthcheckApi - functional programming interface + * @export + */ +export const HealthcheckApiFp = function(configuration?: Configuration) { + return { + /** + * + * @summary Server healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async healthz(xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await HealthcheckApiAxiosParamCreator(configuration).healthz(xRequestID, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: (configuration?.basePath || basePath) + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * + * @summary Server health check + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async ping(xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await HealthcheckApiAxiosParamCreator(configuration).ping(xRequestID, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: (configuration?.basePath || basePath) + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * + * @summary License healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async readyz(xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await HealthcheckApiAxiosParamCreator(configuration).readyz(xRequestID, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: (configuration?.basePath || basePath) + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + } +}; + +/** + * HealthcheckApi - factory interface + * @export + */ +export const HealthcheckApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + return { + /** + * + * @summary Server healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + healthz(xRequestID?: string, options?: any): AxiosPromise { + return HealthcheckApiFp(configuration).healthz(xRequestID, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Server health check + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + ping(xRequestID?: string, options?: any): AxiosPromise { + return HealthcheckApiFp(configuration).ping(xRequestID, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary License healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + readyz(xRequestID?: string, options?: any): AxiosPromise { + return HealthcheckApiFp(configuration).readyz(xRequestID, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * HealthcheckApi - object-oriented interface + * @export + * @class HealthcheckApi + * @extends {BaseAPI} + */ +export class HealthcheckApi extends BaseAPI { + /** + * + * @summary Server healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HealthcheckApi + */ + public healthz(xRequestID?: string, options?: any) { + return HealthcheckApiFp(this.configuration).healthz(xRequestID, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Server health check + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HealthcheckApi + */ + public ping(xRequestID?: string, options?: any) { + return HealthcheckApiFp(this.configuration).ping(xRequestID, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary License healthcheck + * @param {string} [xRequestID] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HealthcheckApi + */ + public readyz(xRequestID?: string, options?: any) { + return HealthcheckApiFp(this.configuration).readyz(xRequestID, options).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/models/authenticity-result-type.ts b/src/models/authenticity-result-type.ts index 548148a1..6048be44 100644 --- a/src/models/authenticity-result-type.ts +++ b/src/models/authenticity-result-type.ts @@ -57,11 +57,11 @@ export enum AuthenticityResultType { */ PHOTO_EMBED_TYPE = 512, /** - * OVI check + * OVI check. Deprecated, use Document liveness check instead */ OVI = 1024, /** - * Hologram presence check + * Hologram presence check. Deprecated */ HOLOGRAMS = 4096, /** diff --git a/src/models/device-info2.ts b/src/models/device-info2.ts new file mode 100644 index 00000000..e8f395a8 --- /dev/null +++ b/src/models/device-info2.ts @@ -0,0 +1,67 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Regula Document Reader Web API + * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core + * + * The version of the OpenAPI document: 7.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 DeviceInfo2 + */ +export interface DeviceInfo2 { + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + app?: string; + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + licenseId?: string; + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + licenseType?: string; + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + licenseSerial?: string; + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + licenseValidUntil?: string; + /** + * + * @type {Array} + * @memberof DeviceInfo2 + */ + scenarios?: Array; + /** + * + * @type {string} + * @memberof DeviceInfo2 + */ + version?: string; +} + + diff --git a/src/models/index.ts b/src/models/index.ts index 8cd037a7..2ddd820e 100755 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -21,6 +21,7 @@ export * from './data-module'; export * from './details-optical'; export * from './details-rfid'; export * from './device-info'; +export * from './device-info2'; export * from './doc-bar-code-info'; export * from './doc-bar-code-info-all-of'; export * from './doc-bar-code-info-fields-list'; diff --git a/src/models/process-params.ts b/src/models/process-params.ts index 232bc9ff..2da26b78 100755 --- a/src/models/process-params.ts +++ b/src/models/process-params.ts @@ -265,6 +265,12 @@ export interface ProcessParams { * @memberof ProcessParams */ forceReadMrzBeforeLocate?: boolean; + /** + * Allows you to bypass the minimum conditions that should be met to perform the barcode format check + * @type {boolean} + * @memberof ProcessParams + */ + forceBarcodeChecks?: boolean; /** * This option can be disabled to stop parsing after barcode is read. Enabled by default. * @type {boolean}