SP-24487 - Response rename

generator-templates/licenseInfo.mustache

@@ -1,4 +1,4 @@
 /**
- * NOTE: This class is auto generated by OpenAPI Generator.
- * Do not edit the class manually.
+ * NOTE: This file is auto generated by OpenAPI Generator.
+ * Do not edit the file manually.
  */

src/ext/document-reader.ts

@@ -1,7 +1,7 @@
 import { HealthcheckApi } from '../api/healthcheck-api';
 import { ProcessApi } from '../api/process-api';
 import { TransactionApi } from '../api/transaction-api';
-import { Response } from './process-response';
+import { ProcessResult } from './process-result';
 import { Configuration, ConfigurationParameters } from '../configuration';
 import globalAxios, { AxiosInstance, AxiosResponse } from 'axios';
 import { BASE_PATH } from '../base';
@@ -60,7 +60,7 @@ export class DocumentReaderApi {
         request: ProcessRequestExt | ProcessRequestBase,
         xRequestID?: string,
         options?: any,
-    ): Promise<Response> {
+    ): Promise<ProcessResult> {
         let baseRequest;
 
         if (instanceOfProcessRequest(request)) {
@@ -84,7 +84,7 @@ export class DocumentReaderApi {
         }
 
         const axiosResult = await this.processApi.apiProcess(baseRequest, xRequestID, options);
-        return new Response(axiosResult.data);
+        return new ProcessResult(axiosResult.data);
     }
 
     public setLicense(license: ArrayBuffer | Base64String) {
@@ -123,13 +123,17 @@ export class DocumentReaderApi {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    async getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: any): Promise<Response> {
+    async getReprocessTransactionResult(
+        transactionId: string,
+        withImages?: boolean,
+        options?: any,
+    ): Promise<ProcessResult> {
         const axiosResult = await this.transactionApi.apiV2TransactionTransactionIdResultsGet(
             transactionId,
             withImages,
             options,
         );
-        return new Response(axiosResult.data);
+        return new ProcessResult(axiosResult.data);
     }
 
     /**

src/ext/index.ts

@@ -1,7 +1,7 @@
 export * from './document-reader';
 export * from './process-request-ext';
 export * from './process-request-image-wrapper';
-export * from './process-response';
+export * from './process-result';
 export * from './text-ext';
 export * from './images-ext';
 export * from './text-field-ext';

src/ext/process-response.ts → src/ext/process-result.ts

@@ -22,7 +22,7 @@ import * as converter from 'base64-arraybuffer';
 import { Authenticity } from './authenticity';
 import * as pako from 'pako';
 
-export class Response {
+export class ProcessResult {
     // other future modules:
     // - authenticity
     // - document
@@ -193,3 +193,8 @@ export class LowLvlResponse implements ProcessResponse {
         return this.ContainerList.List.filter((container) => container.result_type === type);
     }
 }
+
+/**
+ * @deprecated use `ProcessResult` instead.
+ */
+export { ProcessResult as Response };

src/index.ts

@@ -1,3 +1,3 @@
-export * from './ext/index';
+export * from './ext';
 export * from './configuration';
 export * from './models';