Skip to content

Restructure docs test #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions src/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
api.ts
api/diagnostics-api.ts
api/group-api.ts
api/liveness20-api.ts
api/matching-api.ts
api/person-api.ts
api/search-api.ts
api/diagnostic-api.ts
api/face-comparison-api.ts
api/face-detection-api.ts
api/face-identification-api.ts
api/liveness-assessment-api.ts
base.ts
common.ts
configuration.ts
Expand Down
11 changes: 5 additions & 6 deletions src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@



export * from './api/diagnostics-api';
export * from './api/group-api';
export * from './api/liveness20-api';
export * from './api/matching-api';
export * from './api/person-api';
export * from './api/search-api';
export * from './api/diagnostic-api';
export * from './api/face-comparison-api';
export * from './api/face-detection-api';
export * from './api/face-identification-api';
export * from './api/liveness-assessment-api';

126 changes: 126 additions & 0 deletions src/api/diagnostic-api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
/* tslint:disable */
/* eslint-disable */
/**
* Regula Face SDK Web API
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face Detection</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face Match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face Search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness Assessment</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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: 6.1.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, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
/**
* DiagnosticApi - axios parameter creator
* @export
*/
export const DiagnosticApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Checking the license status
* @param {string} [xRequestID] Request header label.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
readiness: async (xRequestID?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/readiness`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
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);
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};

/**
* DiagnosticApi - functional programming interface
* @export
*/
export const DiagnosticApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = DiagnosticApiAxiosParamCreator(configuration)
return {
/**
*
* @summary Checking the license status
* @param {string} [xRequestID] Request header label.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async readiness(xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: object; }>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.readiness(xRequestID, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};

/**
* DiagnosticApi - factory interface
* @export
*/
export const DiagnosticApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = DiagnosticApiFp(configuration)
return {
/**
*
* @summary Checking the license status
* @param {string} [xRequestID] Request header label.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
readiness(xRequestID?: string, options?: any): AxiosPromise<{ [key: string]: object; }> {
return localVarFp.readiness(xRequestID, options).then((request) => request(axios, basePath));
},
};
};

/**
* DiagnosticApi - object-oriented interface
* @export
* @class DiagnosticApi
* @extends {BaseAPI}
*/
export class DiagnosticApi extends BaseAPI {
/**
*
* @summary Checking the license status
* @param {string} [xRequestID] Request header label.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DiagnosticApi
*/
public readiness(xRequestID?: string, options?: AxiosRequestConfig) {
return DiagnosticApiFp(this.configuration).readiness(xRequestID, options).then((request) => request(this.axios, this.basePath));
}
}
Loading