Skip to content

Commit 24cb4ca

Browse files
authored
Cloud Release 23.2 (#52)
1 parent cd48b09 commit 24cb4ca

7 files changed

Lines changed: 38 additions & 22 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Class | Method | HTTP request | Description
164164
----- | ------ | ------------ | -----------
165165
*BarcodeApi* | [**getBarcodeGenerate**](docs/BarcodeApi.md#getBarcodeGenerate) | **GET** /barcode/generate | Generate barcode.
166166
*BarcodeApi* | [**getBarcodeRecognize**](docs/BarcodeApi.md#getBarcodeRecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
167-
*BarcodeApi* | [**postBarcodeRecognizeFromUrlOrContent**](docs/BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
167+
*BarcodeApi* | [**postBarcodeRecognizeFromUrlOrContent**](docs/BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
168168
*BarcodeApi* | [**postGenerateMultiple**](docs/BarcodeApi.md#postGenerateMultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
169169
*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)
170170
*BarcodeApi* | [**putBarcodeRecognizeFromBody**](docs/BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.

docs/BarcodeApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------ | ------------ | -----------
77
[**getBarcodeGenerate**](BarcodeApi.md#getBarcodeGenerate) | **GET** /barcode/generate | Generate barcode.
88
[**getBarcodeRecognize**](BarcodeApi.md#getBarcodeRecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
9-
[**postBarcodeRecognizeFromUrlOrContent**](BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
9+
[**postBarcodeRecognizeFromUrlOrContent**](BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
1010
[**postGenerateMultiple**](BarcodeApi.md#postGenerateMultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
1111
[**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)
1212
[**putBarcodeRecognizeFromBody**](BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
@@ -147,7 +147,7 @@ Name | Type | Description | Notes
147147
**rectWidth** | **Integer**| Set Width of area for recognition. | [optional]
148148
**rectHeight** | **Integer**| Set Height of area for recognition. | [optional]
149149
**stripFNC** | **Boolean**| Value indicating whether FNC symbol strip must be done. | [optional]
150-
**timeout** | **Integer**| Timeout of recognition process. | [optional]
150+
**timeout** | **Integer**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
151151
**medianSmoothingWindowSize** | **Integer**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
152152
**allowMedianSmoothing** | **Boolean**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
153153
**allowComplexBackground** | **Boolean**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
@@ -171,7 +171,7 @@ Name | Type | Description | Notes
171171
**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]
172172
**readTinyBarcodes** | **Boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
173173
**australianPostEncodingTable** | **String**| Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] [enum: CTable, NTable, Other]
174-
**ignoreEndingFillingPatternsForCTable** | **Boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\". | [optional]
174+
**ignoreEndingFillingPatternsForCTable** | **Boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\". | [optional]
175175
**rectangleRegion** | **String**| | [optional]
176176
**storage** | **String**| The image storage. | [optional]
177177
**folder** | **String**| The image folder. | [optional]
@@ -184,7 +184,7 @@ Name | Type | Description | Notes
184184

185185
> BarcodeResponseList postBarcodeRecognizeFromUrlOrContent(type, checksumValidation, detectEncoding, preset, rectX, rectY, rectWidth, rectHeight, stripFNC, timeout, medianSmoothingWindowSize, allowMedianSmoothing, allowComplexBackground, allowDatamatrixIndustrialBarcodes, allowDecreasedImage, allowDetectScanGap, allowIncorrectBarcodes, allowInvertImage, allowMicroWhiteSpotsRemoving, allowOneDFastBarcodesDetector, allowOneDWipedBarsRestoration, allowQRMicroQrRestoration, allowRegularImage, allowSaltAndPepperFiltering, allowWhiteSpotsRemoving, checkMore1DVariants, fastScanOnly, regionLikelihoodThresholdPercent, scanWindowSizes, similarity, skipDiagonalSearch, readTinyBarcodes, australianPostEncodingTable, ignoreEndingFillingPatternsForCTable, rectangleRegion, url, image)
186186
187-
Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
187+
Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
188188

189189
### postBarcodeRecognizeFromUrlOrContent example
190190

@@ -230,7 +230,7 @@ Name | Type | Description | Notes
230230
**rectWidth** | **Integer**| Set Width of area for recognition. | [optional]
231231
**rectHeight** | **Integer**| Set Height of area for recognition. | [optional]
232232
**stripFNC** | **Boolean**| Value indicating whether FNC symbol strip must be done. | [optional]
233-
**timeout** | **Integer**| Timeout of recognition process. | [optional]
233+
**timeout** | **Integer**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
234234
**medianSmoothingWindowSize** | **Integer**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
235235
**allowMedianSmoothing** | **Boolean**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
236236
**allowComplexBackground** | **Boolean**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
@@ -254,7 +254,7 @@ Name | Type | Description | Notes
254254
**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]
255255
**readTinyBarcodes** | **Boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
256256
**australianPostEncodingTable** | **String**| Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional] [enum: CTable, NTable, Other]
257-
**ignoreEndingFillingPatternsForCTable** | **Boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\". | [optional]
257+
**ignoreEndingFillingPatternsForCTable** | **Boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\". | [optional]
258258
**rectangleRegion** | **String**| | [optional]
259259
**url** | **String**| The image file url. | [optional]
260260
**image** | **File**| Image data | [optional]

docs/ReaderParams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**rectWidth** | **Integer** | Set Width of area for recognition. | [optional]
1414
**rectHeight** | **Integer** | Set Height of area for recognition. | [optional]
1515
**stripFNC** | **Boolean** | Value indicating whether FNC symbol strip must be done. | [optional]
16-
**timeout** | **Integer** | Timeout of recognition process. | [optional]
16+
**timeout** | **Integer** | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
1717
**medianSmoothingWindowSize** | **Integer** | Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
1818
**allowMedianSmoothing** | **Boolean** | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
1919
**allowComplexBackground** | **Boolean** | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
@@ -37,7 +37,7 @@ Name | Type | Description | Notes
3737
**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]
3838
**readTinyBarcodes** | **Boolean** | Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
3939
**australianPostEncodingTable** | [**CustomerInformationInterpretingType**](CustomerInformationInterpretingType.md) | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional]
40-
**ignoreEndingFillingPatternsForCTable** | **Boolean** | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\". | [optional]
40+
**ignoreEndingFillingPatternsForCTable** | **Boolean** | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\". | [optional]
4141

4242

4343

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,8 @@ private com.squareup.okhttp.Call postBarcodeRecognizeFromUrlOrContentValidateBef
777777

778778
/**
779779
* Recognize barcode from an url or from request body. Request body can contain raw data bytes
780-
* of the image or encoded with base64.
780+
* of the image with content-type \"application/octet-stream\". An image can also be
781+
* passed as a form field.
781782
*
782783
* @param request See {@link PostBarcodeRecognizeFromUrlOrContentRequest}
783784
* @return BarcodeResponseList
@@ -793,7 +794,8 @@ public BarcodeResponseList postBarcodeRecognizeFromUrlOrContent(
793794

794795
/**
795796
* Recognize barcode from an url or from request body. Request body can contain raw data bytes
796-
* of the image or encoded with base64.
797+
* of the image with content-type \"application/octet-stream\". An image can also be
798+
* passed as a form field.
797799
*
798800
* @param request See {@link PostBarcodeRecognizeFromUrlOrContentRequest}
799801
* @return ApiResponse<BarcodeResponseList>
@@ -810,7 +812,8 @@ public ApiResponse<BarcodeResponseList> postBarcodeRecognizeFromUrlOrContentWith
810812

811813
/**
812814
* Recognize barcode from an url or from request body. Request body can contain raw data bytes
813-
* of the image or encoded with base64. (asynchronously)
815+
* of the image with content-type \&quot;application/octet-stream\&quot;. An image can also be
816+
* passed as a form field. (asynchronously)
814817
*
815818
* @param request See {@link PostBarcodeRecognizeFromUrlOrContentRequest}
816819
* @param callback The callback to be executed when the API call finishes

src/main/java/com/aspose/barcode/cloud/model/ReaderParams.java

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -274,11 +274,15 @@ public void setStripFNC(Boolean stripFNC) {
274274
}
275275

276276
/**
277-
* Timeout of recognition process.
277+
* Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case
278+
* of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to
279+
* avoid timeout.
278280
*
279281
* @return timeout
280282
*/
281-
@ApiModelProperty(value = "Timeout of recognition process.")
283+
@ApiModelProperty(
284+
value =
285+
"Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout.")
282286
public Integer getTimeout() {
283287
return timeout;
284288
}
@@ -693,14 +697,14 @@ public void setAustralianPostEncodingTable(
693697
/**
694698
* The flag which force AustraliaPost decoder to ignore last filling patterns in Customer
695699
* Information Field during decoding as CTable method. CTable encoding method does not have any
696-
* gaps in encoding table and sequnce \&quot;333\&quot; of filling paterns is decoded as letter
697-
* \&quot;z\&quot;.
700+
* gaps in encoding table and sequence \&quot;333\&quot; of filling patterns is decoded as
701+
* letter \&quot;z\&quot;.
698702
*
699703
* @return ignoreEndingFillingPatternsForCTable
700704
*/
701705
@ApiModelProperty(
702706
value =
703-
"The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\".")
707+
"The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\".")
704708
public Boolean isIgnoreEndingFillingPatternsForCTable() {
705709
return ignoreEndingFillingPatternsForCTable;
706710
}

src/main/java/com/aspose/barcode/cloud/requests/GetBarcodeRecognizeRequest.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,11 @@ public class GetBarcodeRecognizeRequest {
6363
public Integer rectHeight;
6464
/** Value indicating whether FNC symbol strip must be done. */
6565
public Boolean stripFNC;
66-
/** Timeout of recognition process. */
66+
/**
67+
* Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case
68+
* of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to
69+
* avoid timeout.
70+
*/
6771
public Integer timeout;
6872
/**
6973
* Window size for median smoothing. Typical values are 3 or 4. Default value is 3.
@@ -186,7 +190,7 @@ public class GetBarcodeRecognizeRequest {
186190
/**
187191
* The flag which force AustraliaPost decoder to ignore last filling patterns in Customer
188192
* Information Field during decoding as CTable method. CTable encoding method does not have any
189-
* gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
193+
* gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z".
190194
*/
191195
public Boolean ignoreEndingFillingPatternsForCTable;
192196
/** */

src/main/java/com/aspose/barcode/cloud/requests/PostBarcodeRecognizeFromUrlOrContentRequest.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434

3535
/**
3636
* Recognize barcode from an url or from request body. Request body can contain raw data bytes of
37-
* the image or encoded with base64.
37+
* the image with content-type \"application/octet-stream\". An image can also be passed as a form
38+
* field.
3839
*/
3940
public class PostBarcodeRecognizeFromUrlOrContentRequest {
4041
/** The type of barcode to read. */
@@ -65,7 +66,11 @@ public class PostBarcodeRecognizeFromUrlOrContentRequest {
6566
public Integer rectHeight;
6667
/** Value indicating whether FNC symbol strip must be done. */
6768
public Boolean stripFNC;
68-
/** Timeout of recognition process. */
69+
/**
70+
* Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case
71+
* of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to
72+
* avoid timeout.
73+
*/
6974
public Integer timeout;
7075
/**
7176
* Window size for median smoothing. Typical values are 3 or 4. Default value is 3.
@@ -188,7 +193,7 @@ public class PostBarcodeRecognizeFromUrlOrContentRequest {
188193
/**
189194
* The flag which force AustraliaPost decoder to ignore last filling patterns in Customer
190195
* Information Field during decoding as CTable method. CTable encoding method does not have any
191-
* gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
196+
* gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z".
192197
*/
193198
public Boolean ignoreEndingFillingPatternsForCTable;
194199
/** */

0 commit comments

Comments
 (0)