Commit: ada4e121

src/.openapi-generator/FILES

@@ -1,3 +1,4 @@
+api/default-api.ts
 api/healthcheck-api.ts
 api/process-api.ts
 api/transaction-api.ts
@@ -34,6 +35,8 @@ models/container-list.ts
 models/critical.ts
 models/cross-source-value-comparison.ts
 models/data-module.ts
+models/database-document-list.ts
+models/database-document.ts
 models/details-optical.ts
 models/details-rfid.ts
 models/device-info-documents-database.ts

src/api/default-api.ts

@@ -0,0 +1,117 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This file is auto generated by OpenAPI Generator.
+ * Do not edit the file manually.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// 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, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { DatabaseDocumentList } from '../models';
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Returns the list of documents stored in the database that the Web Service API is running with.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        doclist: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/doclist`;
+            // 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;
+
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Returns the list of documents stored in the database that the Web Service API is running with.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async doclist(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatabaseDocumentList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.doclist(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DefaultApi.doclist']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DefaultApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Returns the list of documents stored in the database that the Web Service API is running with.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        doclist(options?: RawAxiosRequestConfig): AxiosPromise<DatabaseDocumentList> {
+            return localVarFp.doclist(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     * 
+     * @summary Returns the list of documents stored in the database that the Web Service API is running with.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public doclist(options?: RawAxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).doclist(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

src/api/transaction-api.ts

@@ -178,10 +178,11 @@ export const TransactionApiAxiosParamCreator = function (configuration?: Configu
          * @summary Reprocess
          * @param {string} transactionId Transaction id
          * @param {TransactionProcessRequest} transactionProcessRequest 
+         * @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        apiV2TransactionTransactionIdProcessPost: async (transactionId: string, transactionProcessRequest: TransactionProcessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        apiV2TransactionTransactionIdProcessPost: async (transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'transactionId' is not null or undefined
             assertParamExists('apiV2TransactionTransactionIdProcessPost', 'transactionId', transactionId)
             // verify required parameter 'transactionProcessRequest' is not null or undefined
@@ -199,6 +200,10 @@ export const TransactionApiAxiosParamCreator = function (configuration?: Configu
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
+            if (useCache !== undefined) {
+                localVarQueryParameter['useCache'] = useCache;
+            }
+
 
 
             localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -320,11 +325,12 @@ export const TransactionApiFp = function(configuration?: Configuration) {
          * @summary Reprocess
          * @param {string} transactionId Transaction id
          * @param {TransactionProcessRequest} transactionProcessRequest 
+         * @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionProcessResult>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options);
+        async apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionProcessResult>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['TransactionApi.apiV2TransactionTransactionIdProcessPost']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -399,11 +405,12 @@ export const TransactionApiFactory = function (configuration?: Configuration, ba
          * @summary Reprocess
          * @param {string} transactionId Transaction id
          * @param {TransactionProcessRequest} transactionProcessRequest 
+         * @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionProcessResult> {
-            return localVarFp.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options).then((request) => request(axios, basePath));
+        apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<TransactionProcessResult> {
+            return localVarFp.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -480,12 +487,13 @@ export class TransactionApi extends BaseAPI {
      * @summary Reprocess
      * @param {string} transactionId Transaction id
      * @param {TransactionProcessRequest} transactionProcessRequest 
+     * @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TransactionApi
      */
-    public apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig) {
-        return TransactionApiFp(this.configuration).apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options).then((request) => request(this.axios, this.basePath));
+    public apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean, options?: RawAxiosRequestConfig) {
+        return TransactionApiFp(this.configuration).apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

src/models/database-document-list.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This file is auto generated by OpenAPI Generator.
+ * Do not edit the file manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DatabaseDocument } from './database-document';
+
+/**
+ * 
+ * @export
+ * @interface DatabaseDocumentList
+ */
+export interface DatabaseDocumentList {
+    /**
+     * The list of documents stored in the database.
+     * @type {Array<DatabaseDocument>}
+     * @memberof DatabaseDocumentList
+     */
+    'items': Array<DatabaseDocument>;
+}
+

src/models/database-document.ts

@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This file is auto generated by OpenAPI Generator.
+ * Do not edit the file manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DocumentType } from './document-type';
+
+/**
+ * 
+ * @export
+ * @interface DatabaseDocument
+ */
+export interface DatabaseDocument {
+    /**
+     * Whether the document has a barcode.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'barcode_fields': boolean;
+    /**
+     * Country name.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'country': string;
+    /**
+     * Date when the document description was created in the database.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'createad': string;
+    /**
+     * 
+     * @type {DocumentType}
+     * @memberof DatabaseDocument
+     */
+    'doc_type': DocumentType;
+    /**
+     * Document name.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'document': string;
+    /**
+     * The presence of graphic fields in the document.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'graphic_fields': boolean;
+    /**
+     * Document code.
+     * @type {number}
+     * @memberof DatabaseDocument
+     */
+    'id': number;
+    /**
+     * The document has an MRZ.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'mrz': boolean;
+    /**
+     * Country region.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'region'?: string;
+    /**
+     * The document has an RFID chip.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'rfid_chip': boolean;
+    /**
+     * The presence of text fields in the document.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'text_fields': boolean;
+    /**
+     * Date when the document description was updated in the database.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'updated': string;
+    /**
+     * The year when the document was issued.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'year'?: string;
+    /**
+     * Guardian country.
+     * @type {string}
+     * @memberof DatabaseDocument
+     */
+    'sovereignty'?: string;
+    /**
+     * Whether the document is no longer in circulation.
+     * @type {boolean}
+     * @memberof DatabaseDocument
+     */
+    'deprecated'?: boolean;
+}
+
+
+

src/models/index.ts

@@ -28,6 +28,8 @@ export * from './container-list-list-inner';
 export * from './critical';
 export * from './cross-source-value-comparison';
 export * from './data-module';
+export * from './database-document';
+export * from './database-document-list';
 export * from './details-optical';
 export * from './details-rfid';
 export * from './device-info';

src/models/process-params.ts

@@ -457,6 +457,12 @@ export interface ProcessParams {
      * @memberof ProcessParams
      */
     'strictSecurityChecks'?: boolean;
+    /**
+     * Allows transliteration to be turned on or off; by default, it is enabled.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    'returnTransliteratedFields'?: boolean;
 }