Add ScanBarcode endpoint

Author: Denis-Averin

README.md

@@ -170,6 +170,7 @@ Class | Method | HTTP request | Description
 *BarcodeApi* | [**putBarcodeGenerateFile**](docs/BarcodeApi.md#putBarcodeGenerateFile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
 *BarcodeApi* | [**putBarcodeRecognizeFromBody**](docs/BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
 *BarcodeApi* | [**putGenerateMultiple**](docs/BarcodeApi.md#putGenerateMultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
+*BarcodeApi* | [**scanBarcode**](docs/BarcodeApi.md#scanBarcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
 *FileApi* | [**copyFile**](docs/FileApi.md#copyFile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
 *FileApi* | [**deleteFile**](docs/FileApi.md#deleteFile) | **DELETE** /barcode/storage/file/{path} | Delete file
 *FileApi* | [**downloadFile**](docs/FileApi.md#downloadFile) | **GET** /barcode/storage/file/{path} | Download file

docs/BarcodeApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**putBarcodeGenerateFile**](BarcodeApi.md#putBarcodeGenerateFile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
 [**putBarcodeRecognizeFromBody**](BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
 [**putGenerateMultiple**](BarcodeApi.md#putGenerateMultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
+[**scanBarcode**](BarcodeApi.md#scanBarcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
 
 ## getBarcodeGenerate
 
@@ -170,7 +171,7 @@ Name | Type | Description  | Notes
  **allowAdditionalRestorations** | **Boolean**| Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False. | [optional]
  **regionLikelihoodThresholdPercent** | **Double**| Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. | [optional]
  **scanWindowSizes** | **List<Integer>**| Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. | [optional]
- **similarity** | **Double**| Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional]
+ **similarity** | **Double**| Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional]
  **skipDiagonalSearch** | **Boolean**| Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional]
  **readTinyBarcodes** | **Boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
  **australianPostEncodingTable** | **String**| Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] [enum: CTable, NTable, Other]
@@ -254,7 +255,7 @@ Name | Type | Description  | Notes
  **allowAdditionalRestorations** | **Boolean**| Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False. | [optional]
  **regionLikelihoodThresholdPercent** | **Double**| Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. | [optional]
  **scanWindowSizes** | **List<Integer>**| Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. | [optional]
- **similarity** | **Double**| Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional]
+ **similarity** | **Double**| Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] | [optional]
  **skipDiagonalSearch** | **Boolean**| Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional]
  **readTinyBarcodes** | **Boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
  **australianPostEncodingTable** | **String**| Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] [enum: CTable, NTable, Other]
@@ -509,3 +510,53 @@ Name | Type | Description  | Notes
 
 [**ResultImageInfo**](ResultImageInfo.md)
 
+## scanBarcode
+
+> BarcodeResponseList scanBarcode(imageFile, decodeTypes, timeout)
+
+Quickly scan a barcode from an image.
+
+### scanBarcode example
+
+```java
+// Import classes:
+import com.aspose.barcode.cloud.ApiClient;
+import com.aspose.barcode.cloud.ApiException;
+import com.aspose.barcode.cloud.Configuration;
+import com.aspose.barcode.cloud.auth.*;
+import com.aspose.barcode.cloud.api.BarcodeApi;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        ApiClient client = new ApiClient(
+            "Client Id from https://dashboard.aspose.cloud/applications",
+            "Client Secret from https://dashboard.aspose.cloud/applications"
+        );
+
+        BarcodeApi api = new BarcodeApi(client);
+        File imageFile = new File("/path/to/file.txt"); // File | Image as file
+        try {
+            BarcodeResponseList result = api.scanBarcode(imageFile);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling BarcodeApi.scanBarcode");
+            e.printStackTrace();
+        }
+    }
+}
+```
+
+### scanBarcode parameters
+
+Name | Type | Description  | Notes
+---- | ---- | ------------ | -----
+ **imageFile** | **File**| Image as file |
+ **decodeTypes** | [**List<DecodeBarcodeType>**](DecodeBarcodeType.md)| Types of barcode to recognize | [optional]
+ **timeout** | **Integer**| Timeout of recognition process in milliseconds.  Default value is 15_000 (15 seconds).  Maximum value is 30_000 (1/2 minute).  In case of a timeout RequestTimeout (408) status will be returned.  Try reducing the image size to avoid timeout. | [optional]
+
+### scanBarcode return type
+
+[**BarcodeResponseList**](BarcodeResponseList.md)
+

docs/ReaderParams.md

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
 **allowAdditionalRestorations** | **Boolean** | Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False. |  [optional]
 **regionLikelihoodThresholdPercent** | **Double** | Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. |  [optional]
 **scanWindowSizes** | **List<Integer>** | Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. |  [optional]
-**similarity** | **Double** | Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] |  [optional]
+**similarity** | **Double** | Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] |  [optional]
 **skipDiagonalSearch** | **Boolean** | Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. |  [optional]
 **readTinyBarcodes** | **Boolean** | Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. |  [optional]
 **australianPostEncodingTable** | [**CustomerInformationInterpretingType**](CustomerInformationInterpretingType.md) | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. |  [optional]

src/main/java/com/aspose/barcode/cloud/ApiClient.java

@@ -894,8 +894,9 @@ public RequestBody buildRequestBodyFormEncoding(Map<String, Object> formParams)
     public RequestBody buildRequestBodyMultipart(Map<String, Object> formParams) {
         MultipartBuilder mpBuilder = new MultipartBuilder().type(MultipartBuilder.FORM);
         for (Entry<String, Object> param : formParams.entrySet()) {
-            if (param.getValue() instanceof File) {
-                File file = (File) param.getValue();
+            Object paramValue = param.getValue();
+            if (paramValue instanceof File) {
+                File file = (File) paramValue;
                 Headers partHeaders =
                         Headers.of(
                                 "Content-Disposition",
@@ -906,13 +907,23 @@ public RequestBody buildRequestBodyMultipart(Map<String, Object> formParams) {
                                         + "\"");
                 MediaType mediaType = MediaType.parse(guessContentTypeFromFile(file));
                 mpBuilder.addPart(partHeaders, RequestBody.create(mediaType, file));
+            } else if (paramValue instanceof Collection) {
+                Collection<Object> collection = (Collection<Object>) paramValue;
+                for (Object item : collection) {
+                    Headers partHeaders =
+                            Headers.of(
+                                    "Content-Disposition",
+                                    "form-data; name=\"" + param.getKey() + "\"");
+                    mpBuilder.addPart(
+                            partHeaders, RequestBody.create(null, parameterToString(item)));
+                }
             } else {
                 Headers partHeaders =
                         Headers.of(
                                 "Content-Disposition",
                                 "form-data; name=\"" + param.getKey() + "\"");
                 mpBuilder.addPart(
-                        partHeaders, RequestBody.create(null, parameterToString(param.getValue())));
+                        partHeaders, RequestBody.create(null, parameterToString(paramValue)));
             }
         }
         return mpBuilder.build();

src/main/java/com/aspose/barcode/cloud/api/BarcodeApi.java

@@ -1949,4 +1949,173 @@ public void onRequestProgress(
         apiClient.executeAsync(call, returnType, callback);
         return call;
     }
+
+    /**
+     * Build call for scanBarcode
+     *
+     * @param request See {@link ScanBarcodeRequest}
+     * @param progressListener Progress listener
+     * @param progressRequestListener Progress request listener
+     * @return Call to execute
+     * @throws ApiException If fail to serialize the request body object
+     */
+    @SuppressWarnings("removal")
+    protected com.squareup.okhttp.Call scanBarcodeCall(
+            ScanBarcodeRequest request,
+            final ProgressResponseBody.ProgressListener progressListener,
+            final ProgressRequestBody.ProgressRequestListener progressRequestListener)
+            throws ApiException {
+        Object postBody = null;
+
+        // create path and map variables
+        String path = "/barcode/scan";
+
+        List<Pair> queryParams = new ArrayList<>();
+        List<Pair> collectionQueryParams = new ArrayList<>();
+        Map<String, String> headerParams = new HashMap<>();
+
+        Map<String, Object> formParams = new HashMap<>();
+        if (request.imageFile != null) {
+            formParams.put("imageFile", request.imageFile);
+        }
+
+        if (request.decodeTypes != null) {
+            formParams.put("decodeTypes", request.decodeTypes);
+        }
+
+        if (request.timeout != null) {
+            formParams.put("timeout", request.timeout);
+        }
+
+        final String[] accepts = {"application/json"};
+        final String accept = apiClient.selectHeaderAccept(accepts);
+        if (accept != null) {
+            headerParams.put("Accept", accept);
+        }
+
+        final String[] contentTypes = {"multipart/form-data"};
+        final String contentType = apiClient.selectHeaderContentType(contentTypes);
+        headerParams.put("Content-Type", contentType);
+
+        if (progressListener != null) {
+            apiClient
+                    .getHttpClient()
+                    .networkInterceptors()
+                    .add(
+                            new com.squareup.okhttp.Interceptor() {
+                                @Override
+                                public com.squareup.okhttp.Response intercept(
+                                        com.squareup.okhttp.Interceptor.Chain chain)
+                                        throws IOException {
+                                    com.squareup.okhttp.Response originalResponse =
+                                            chain.proceed(chain.request());
+                                    return originalResponse
+                                            .newBuilder()
+                                            .body(
+                                                    new ProgressResponseBody(
+                                                            originalResponse.body(),
+                                                            progressListener))
+                                            .build();
+                                }
+                            });
+        }
+
+        return apiClient.buildCall(
+                path,
+                "POST",
+                queryParams,
+                collectionQueryParams,
+                postBody,
+                headerParams,
+                formParams,
+                progressRequestListener);
+    }
+
+    private com.squareup.okhttp.Call scanBarcodeValidateBeforeCall(
+            ScanBarcodeRequest request,
+            final ProgressResponseBody.ProgressListener progressListener,
+            final ProgressRequestBody.ProgressRequestListener progressRequestListener)
+            throws ApiException {
+
+        // verify the required parameter 'request.imageFile' is set
+        if (request.imageFile == null) {
+            throw new ApiException(
+                    "Missing the required parameter 'request.imageFile'"
+                            + " when calling scanBarcode(...)");
+        }
+
+        com.squareup.okhttp.Call call =
+                scanBarcodeCall(request, progressListener, progressRequestListener);
+        return call;
+    }
+
+    /**
+     * Quickly scan a barcode from an image.
+     *
+     * @param request See {@link ScanBarcodeRequest}
+     * @return BarcodeResponseList
+     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the
+     *     response body
+     */
+    public BarcodeResponseList scanBarcode(ScanBarcodeRequest request) throws ApiException {
+        ApiResponse<BarcodeResponseList> resp = scanBarcodeWithHttpInfo(request);
+        return resp.getData();
+    }
+
+    /**
+     * Quickly scan a barcode from an image.
+     *
+     * @param request See {@link ScanBarcodeRequest}
+     * @return ApiResponse&lt;BarcodeResponseList&gt;
+     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the
+     *     response body
+     */
+    public ApiResponse<BarcodeResponseList> scanBarcodeWithHttpInfo(ScanBarcodeRequest request)
+            throws ApiException {
+        com.squareup.okhttp.Call call = scanBarcodeValidateBeforeCall(request, null, null);
+        Type returnType = new TypeToken<BarcodeResponseList>() {}.getType();
+        return apiClient.execute(call, returnType);
+    }
+
+    /**
+     * Quickly scan a barcode from an image. (asynchronously)
+     *
+     * @param request See {@link ScanBarcodeRequest}
+     * @param callback The callback to be executed when the API call finishes
+     * @return The request call
+     * @throws ApiException If fail to process the API call, e.g. serializing the request body
+     *     object
+     */
+    public com.squareup.okhttp.Call scanBarcodeAsync(
+            ScanBarcodeRequest request, final ApiCallback<BarcodeResponseList> callback)
+            throws ApiException {
+
+        ProgressResponseBody.ProgressListener progressListener = null;
+        ProgressRequestBody.ProgressRequestListener progressRequestListener = null;
+
+        if (callback != null) {
+            progressListener =
+                    new ProgressResponseBody.ProgressListener() {
+                        @Override
+                        public void update(long bytesRead, long contentLength, boolean done) {
+                            callback.onDownloadProgress(bytesRead, contentLength, done);
+                        }
+                    };
+
+            progressRequestListener =
+                    new ProgressRequestBody.ProgressRequestListener() {
+                        @Override
+                        public void onRequestProgress(
+                                long bytesWritten, long contentLength, boolean done) {
+                            callback.onUploadProgress(bytesWritten, contentLength, done);
+                        }
+                    };
+        }
+
+        com.squareup.okhttp.Call call =
+                scanBarcodeValidateBeforeCall(request, progressListener, progressRequestListener);
+        Type returnType = new TypeToken<BarcodeResponseList>() {}.getType();
+        apiClient.executeAsync(call, returnType, callback);
+        return call;
+    }
 }