cloudmersive-barcode-api-client 2.1.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -4
- data/docs/BarcodeAdvancedResultItem.md +9 -0
- data/docs/BarcodeAdvancedScanResult.md +11 -0
- data/docs/BarcodeScanApi.md +59 -2
- data/docs/GenerateBarcodeApi.md +111 -10
- data/lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb +60 -2
- data/lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb +105 -0
- data/lib/cloudmersive-barcode-api-client/models/barcode_advanced_result_item.rb +196 -0
- data/lib/cloudmersive-barcode-api-client/models/barcode_advanced_scan_result.rb +218 -0
- data/lib/cloudmersive-barcode-api-client/models/barcode_qr_result_item.rb +1 -0
- data/lib/cloudmersive-barcode-api-client/version.rb +1 -1
- data/lib/cloudmersive-barcode-api-client.rb +2 -0
- data/spec/api/barcode_scan_api_spec.rb +14 -1
- data/spec/api/generate_barcode_api_spec.rb +29 -0
- data/spec/models/barcode_advanced_result_item_spec.rb +47 -0
- data/spec/models/barcode_advanced_scan_result_spec.rb +59 -0
- metadata +24 -18
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2923d8e6f9c9c521e94556a0c1f4fed7348265aaa3b0ef49e94810f011934707
|
|
4
|
+
data.tar.gz: 0ef6d2b5bb0389e97c90378dca0cac6c7ec476a0f8ea40ac94505118637e78e2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c58f7868238f8dca549bc11281ade81fc59e5a5b51aa546d88bb3b7a638401ed58f4c60cd8926ebc15f1cd3e81c6c93586eff50e594b9067092a00abf9ac4693
|
|
7
|
+
data.tar.gz: d5e7b033efff191708cbe99ad90613ea433649babebb25cb3ff41235ff4f4b7fe4e3dd11e4a3a9ef6a1b8cbd02360e461201161dfcd372790e1653f7506ed6ee
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Barcode APIs let you generate barcode images, and recognize values from images o
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: v1
|
|
10
|
-
- Package version: 2.
|
|
10
|
+
- Package version: 2.2.0
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,15 +23,15 @@ gem build cloudmersive-barcode-api-client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./cloudmersive-barcode-api-client-2.
|
|
26
|
+
gem install ./cloudmersive-barcode-api-client-2.2.0.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-barcode-api-client-2.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-barcode-api-client-2.2.0.gem` to install the development dependencies)
|
|
29
29
|
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
31
|
|
|
32
32
|
Finally add this to the Gemfile:
|
|
33
33
|
|
|
34
|
-
gem 'cloudmersive-barcode-api-client', '~> 2.
|
|
34
|
+
gem 'cloudmersive-barcode-api-client', '~> 2.2.0'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -85,7 +85,9 @@ Class | Method | HTTP request | Description
|
|
|
85
85
|
------------ | ------------- | ------------- | -------------
|
|
86
86
|
*CloudmersiveBarcodeApiClient::BarcodeLookupApi* | [**barcode_lookup_ean_lookup**](docs/BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
|
|
87
87
|
*CloudmersiveBarcodeApiClient::BarcodeScanApi* | [**barcode_scan_image**](docs/BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
|
|
88
|
+
*CloudmersiveBarcodeApiClient::BarcodeScanApi* | [**barcode_scan_image_advanced**](docs/BarcodeScanApi.md#barcode_scan_image_advanced) | **POST** /barcode/scan/image/advanced | Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
88
89
|
*CloudmersiveBarcodeApiClient::BarcodeScanApi* | [**barcode_scan_image_advanced_qr**](docs/BarcodeScanApi.md#barcode_scan_image_advanced_qr) | **POST** /barcode/scan/image/advanced/qr | Advanced AI scan and recognition of an image of one or more QR barcodes
|
|
90
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_code128**](docs/GenerateBarcodeApi.md#generate_barcode_code128) | **POST** /barcode/generate/code-128 | Generate a EAN-13 code barcode as PNG file
|
|
89
91
|
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
|
|
90
92
|
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean8**](docs/GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
|
|
91
93
|
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_qr_code**](docs/GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
|
|
@@ -95,6 +97,8 @@ Class | Method | HTTP request | Description
|
|
|
95
97
|
|
|
96
98
|
## Documentation for Models
|
|
97
99
|
|
|
100
|
+
- [CloudmersiveBarcodeApiClient::BarcodeAdvancedResultItem](docs/BarcodeAdvancedResultItem.md)
|
|
101
|
+
- [CloudmersiveBarcodeApiClient::BarcodeAdvancedScanResult](docs/BarcodeAdvancedScanResult.md)
|
|
98
102
|
- [CloudmersiveBarcodeApiClient::BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
|
|
99
103
|
- [CloudmersiveBarcodeApiClient::BarcodeQRResultItem](docs/BarcodeQRResultItem.md)
|
|
100
104
|
- [CloudmersiveBarcodeApiClient::BarcodeScanQRAdvancedResult](docs/BarcodeScanQRAdvancedResult.md)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeAdvancedResultItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**raw_text** | **String** | The barcode text | [optional]
|
|
7
|
+
**barcode_type** | **String** | Type of the barcode; supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeAdvancedScanResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**result_barcodes** | [**Array<BarcodeAdvancedResultItem>**](BarcodeAdvancedResultItem.md) | Results of performing the barcode scan operation | [optional]
|
|
8
|
+
**barcode_count** | **Integer** | Number of barcodes read | [optional]
|
|
9
|
+
**error_message** | **String** | Error message if any | [optional]
|
|
10
|
+
|
|
11
|
+
|
data/docs/BarcodeScanApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**barcode_scan_image**](BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
|
|
8
|
+
[**barcode_scan_image_advanced**](BarcodeScanApi.md#barcode_scan_image_advanced) | **POST** /barcode/scan/image/advanced | Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
8
9
|
[**barcode_scan_image_advanced_qr**](BarcodeScanApi.md#barcode_scan_image_advanced_qr) | **POST** /barcode/scan/image/advanced/qr | Advanced AI scan and recognition of an image of one or more QR barcodes
|
|
9
10
|
|
|
10
11
|
|
|
@@ -62,12 +63,66 @@ Name | Type | Description | Notes
|
|
|
62
63
|
|
|
63
64
|
|
|
64
65
|
|
|
66
|
+
# **barcode_scan_image_advanced**
|
|
67
|
+
> BarcodeAdvancedScanResult barcode_scan_image_advanced(image_file)
|
|
68
|
+
|
|
69
|
+
Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
70
|
+
|
|
71
|
+
Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
```ruby
|
|
75
|
+
# load the gem
|
|
76
|
+
require 'cloudmersive-barcode-api-client'
|
|
77
|
+
# setup authorization
|
|
78
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
|
79
|
+
# Configure API key authorization: Apikey
|
|
80
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
82
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
api_instance = CloudmersiveBarcodeApiClient::BarcodeScanApi.new
|
|
86
|
+
|
|
87
|
+
image_file = File.new('/path/to/file.txt') # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
begin
|
|
91
|
+
#Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
92
|
+
result = api_instance.barcode_scan_image_advanced(image_file)
|
|
93
|
+
p result
|
|
94
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
95
|
+
puts "Exception when calling BarcodeScanApi->barcode_scan_image_advanced: #{e}"
|
|
96
|
+
end
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
Name | Type | Description | Notes
|
|
102
|
+
------------- | ------------- | ------------- | -------------
|
|
103
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
[**BarcodeAdvancedScanResult**](BarcodeAdvancedScanResult.md)
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
[Apikey](../README.md#Apikey)
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: multipart/form-data
|
|
116
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
65
120
|
# **barcode_scan_image_advanced_qr**
|
|
66
121
|
> BarcodeScanQRAdvancedResult barcode_scan_image_advanced_qr(image_file, opts)
|
|
67
122
|
|
|
68
123
|
Advanced AI scan and recognition of an image of one or more QR barcodes
|
|
69
124
|
|
|
70
|
-
Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG and JPEG input file formats.
|
|
125
|
+
Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
|
|
71
126
|
|
|
72
127
|
### Example
|
|
73
128
|
```ruby
|
|
@@ -86,7 +141,8 @@ api_instance = CloudmersiveBarcodeApiClient::BarcodeScanApi.new
|
|
|
86
141
|
image_file = File.new('/path/to/file.txt') # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
87
142
|
|
|
88
143
|
opts = {
|
|
89
|
-
preprocessing: 'preprocessing_example' # String | Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
|
|
144
|
+
preprocessing: 'preprocessing_example', # String | Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
|
|
145
|
+
recognition_mode: 'recognition_mode_example' # String | Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition.
|
|
90
146
|
}
|
|
91
147
|
|
|
92
148
|
begin
|
|
@@ -104,6 +160,7 @@ Name | Type | Description | Notes
|
|
|
104
160
|
------------- | ------------- | ------------- | -------------
|
|
105
161
|
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
106
162
|
**preprocessing** | **String**| Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. | [optional]
|
|
163
|
+
**recognition_mode** | **String**| Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition. | [optional]
|
|
107
164
|
|
|
108
165
|
### Return type
|
|
109
166
|
|
data/docs/GenerateBarcodeApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**generate_barcode_code128**](GenerateBarcodeApi.md#generate_barcode_code128) | **POST** /barcode/generate/code-128 | Generate a EAN-13 code barcode as PNG file
|
|
7
8
|
[**generate_barcode_ean13**](GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
|
|
8
9
|
[**generate_barcode_ean8**](GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
|
|
9
10
|
[**generate_barcode_qr_code**](GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
|
|
@@ -11,8 +12,70 @@ Method | HTTP request | Description
|
|
|
11
12
|
[**generate_barcode_upce**](GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
|
|
12
13
|
|
|
13
14
|
|
|
15
|
+
# **generate_barcode_code128**
|
|
16
|
+
> String generate_barcode_code128(value, opts)
|
|
17
|
+
|
|
18
|
+
Generate a EAN-13 code barcode as PNG file
|
|
19
|
+
|
|
20
|
+
Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
```ruby
|
|
24
|
+
# load the gem
|
|
25
|
+
require 'cloudmersive-barcode-api-client'
|
|
26
|
+
# setup authorization
|
|
27
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
|
28
|
+
# Configure API key authorization: Apikey
|
|
29
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
31
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
35
|
+
|
|
36
|
+
value = 'value_example' # String | Barcode value to generate from
|
|
37
|
+
|
|
38
|
+
opts = {
|
|
39
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
40
|
+
height: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
41
|
+
include_label: true # BOOLEAN | Optional: show text label on the image of the barcode value, default is true.
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
begin
|
|
45
|
+
#Generate a EAN-13 code barcode as PNG file
|
|
46
|
+
result = api_instance.generate_barcode_code128(value, opts)
|
|
47
|
+
p result
|
|
48
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
49
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_code128: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
Name | Type | Description | Notes
|
|
56
|
+
------------- | ------------- | ------------- | -------------
|
|
57
|
+
**value** | **String**| Barcode value to generate from |
|
|
58
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
59
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
60
|
+
**include_label** | **BOOLEAN**| Optional: show text label on the image of the barcode value, default is true. | [optional]
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
**String**
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
[Apikey](../README.md#Apikey)
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
73
|
+
- **Accept**: application/octet-stream
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
14
77
|
# **generate_barcode_ean13**
|
|
15
|
-
> String generate_barcode_ean13(value)
|
|
78
|
+
> String generate_barcode_ean13(value, opts)
|
|
16
79
|
|
|
17
80
|
Generate a EAN-13 code barcode as PNG file
|
|
18
81
|
|
|
@@ -34,10 +97,15 @@ api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
|
34
97
|
|
|
35
98
|
value = 'value_example' # String | Barcode value to generate from
|
|
36
99
|
|
|
100
|
+
opts = {
|
|
101
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
102
|
+
height: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
103
|
+
include_label: true # BOOLEAN | Optional: show text label on the image of the barcode value, default is true.
|
|
104
|
+
}
|
|
37
105
|
|
|
38
106
|
begin
|
|
39
107
|
#Generate a EAN-13 code barcode as PNG file
|
|
40
|
-
result = api_instance.generate_barcode_ean13(value)
|
|
108
|
+
result = api_instance.generate_barcode_ean13(value, opts)
|
|
41
109
|
p result
|
|
42
110
|
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
43
111
|
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean13: #{e}"
|
|
@@ -49,6 +117,9 @@ end
|
|
|
49
117
|
Name | Type | Description | Notes
|
|
50
118
|
------------- | ------------- | ------------- | -------------
|
|
51
119
|
**value** | **String**| Barcode value to generate from |
|
|
120
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
121
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
122
|
+
**include_label** | **BOOLEAN**| Optional: show text label on the image of the barcode value, default is true. | [optional]
|
|
52
123
|
|
|
53
124
|
### Return type
|
|
54
125
|
|
|
@@ -66,7 +137,7 @@ Name | Type | Description | Notes
|
|
|
66
137
|
|
|
67
138
|
|
|
68
139
|
# **generate_barcode_ean8**
|
|
69
|
-
> String generate_barcode_ean8(value)
|
|
140
|
+
> String generate_barcode_ean8(value, opts)
|
|
70
141
|
|
|
71
142
|
Generate a EAN-8 code barcode as PNG file
|
|
72
143
|
|
|
@@ -88,10 +159,15 @@ api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
|
88
159
|
|
|
89
160
|
value = 'value_example' # String | Barcode value to generate from
|
|
90
161
|
|
|
162
|
+
opts = {
|
|
163
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
164
|
+
height: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
165
|
+
include_label: true # BOOLEAN | Optional: show text label on the image of the barcode value, default is true.
|
|
166
|
+
}
|
|
91
167
|
|
|
92
168
|
begin
|
|
93
169
|
#Generate a EAN-8 code barcode as PNG file
|
|
94
|
-
result = api_instance.generate_barcode_ean8(value)
|
|
170
|
+
result = api_instance.generate_barcode_ean8(value, opts)
|
|
95
171
|
p result
|
|
96
172
|
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
97
173
|
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean8: #{e}"
|
|
@@ -103,6 +179,9 @@ end
|
|
|
103
179
|
Name | Type | Description | Notes
|
|
104
180
|
------------- | ------------- | ------------- | -------------
|
|
105
181
|
**value** | **String**| Barcode value to generate from |
|
|
182
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
183
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
184
|
+
**include_label** | **BOOLEAN**| Optional: show text label on the image of the barcode value, default is true. | [optional]
|
|
106
185
|
|
|
107
186
|
### Return type
|
|
108
187
|
|
|
@@ -120,7 +199,7 @@ Name | Type | Description | Notes
|
|
|
120
199
|
|
|
121
200
|
|
|
122
201
|
# **generate_barcode_qr_code**
|
|
123
|
-
> String generate_barcode_qr_code(value)
|
|
202
|
+
> String generate_barcode_qr_code(value, opts)
|
|
124
203
|
|
|
125
204
|
Generate a QR code barcode as PNG file
|
|
126
205
|
|
|
@@ -142,10 +221,14 @@ api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
|
142
221
|
|
|
143
222
|
value = 'value_example' # String | QR code text to convert into the QR code barcode
|
|
144
223
|
|
|
224
|
+
opts = {
|
|
225
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
226
|
+
height: 56 # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
227
|
+
}
|
|
145
228
|
|
|
146
229
|
begin
|
|
147
230
|
#Generate a QR code barcode as PNG file
|
|
148
|
-
result = api_instance.generate_barcode_qr_code(value)
|
|
231
|
+
result = api_instance.generate_barcode_qr_code(value, opts)
|
|
149
232
|
p result
|
|
150
233
|
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
151
234
|
puts "Exception when calling GenerateBarcodeApi->generate_barcode_qr_code: #{e}"
|
|
@@ -157,6 +240,8 @@ end
|
|
|
157
240
|
Name | Type | Description | Notes
|
|
158
241
|
------------- | ------------- | ------------- | -------------
|
|
159
242
|
**value** | **String**| QR code text to convert into the QR code barcode |
|
|
243
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
244
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
160
245
|
|
|
161
246
|
### Return type
|
|
162
247
|
|
|
@@ -174,7 +259,7 @@ Name | Type | Description | Notes
|
|
|
174
259
|
|
|
175
260
|
|
|
176
261
|
# **generate_barcode_upca**
|
|
177
|
-
> String generate_barcode_upca(value)
|
|
262
|
+
> String generate_barcode_upca(value, opts)
|
|
178
263
|
|
|
179
264
|
Generate a UPC-A code barcode as PNG file
|
|
180
265
|
|
|
@@ -196,10 +281,15 @@ api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
|
196
281
|
|
|
197
282
|
value = 'value_example' # String | UPC-A barcode value to generate from
|
|
198
283
|
|
|
284
|
+
opts = {
|
|
285
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
286
|
+
height: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
287
|
+
include_label: true # BOOLEAN | Optional: show text label on the image of the barcode value, default is true.
|
|
288
|
+
}
|
|
199
289
|
|
|
200
290
|
begin
|
|
201
291
|
#Generate a UPC-A code barcode as PNG file
|
|
202
|
-
result = api_instance.generate_barcode_upca(value)
|
|
292
|
+
result = api_instance.generate_barcode_upca(value, opts)
|
|
203
293
|
p result
|
|
204
294
|
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
205
295
|
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upca: #{e}"
|
|
@@ -211,6 +301,9 @@ end
|
|
|
211
301
|
Name | Type | Description | Notes
|
|
212
302
|
------------- | ------------- | ------------- | -------------
|
|
213
303
|
**value** | **String**| UPC-A barcode value to generate from |
|
|
304
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
305
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
306
|
+
**include_label** | **BOOLEAN**| Optional: show text label on the image of the barcode value, default is true. | [optional]
|
|
214
307
|
|
|
215
308
|
### Return type
|
|
216
309
|
|
|
@@ -228,7 +321,7 @@ Name | Type | Description | Notes
|
|
|
228
321
|
|
|
229
322
|
|
|
230
323
|
# **generate_barcode_upce**
|
|
231
|
-
> String generate_barcode_upce(value)
|
|
324
|
+
> String generate_barcode_upce(value, opts)
|
|
232
325
|
|
|
233
326
|
Generate a UPC-E code barcode as PNG file
|
|
234
327
|
|
|
@@ -250,10 +343,15 @@ api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
|
|
250
343
|
|
|
251
344
|
value = 'value_example' # String | UPC-E barcode value to generate from
|
|
252
345
|
|
|
346
|
+
opts = {
|
|
347
|
+
width: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
348
|
+
height: 56, # Integer | Optional: width of the barcode in pixels. Minimum value of 10.
|
|
349
|
+
include_label: true # BOOLEAN | Optional: show text label on the image of the barcode value, default is true.
|
|
350
|
+
}
|
|
253
351
|
|
|
254
352
|
begin
|
|
255
353
|
#Generate a UPC-E code barcode as PNG file
|
|
256
|
-
result = api_instance.generate_barcode_upce(value)
|
|
354
|
+
result = api_instance.generate_barcode_upce(value, opts)
|
|
257
355
|
p result
|
|
258
356
|
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
|
259
357
|
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upce: #{e}"
|
|
@@ -265,6 +363,9 @@ end
|
|
|
265
363
|
Name | Type | Description | Notes
|
|
266
364
|
------------- | ------------- | ------------- | -------------
|
|
267
365
|
**value** | **String**| UPC-E barcode value to generate from |
|
|
366
|
+
**width** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
367
|
+
**height** | **Integer**| Optional: width of the barcode in pixels. Minimum value of 10. | [optional]
|
|
368
|
+
**include_label** | **BOOLEAN**| Optional: show text label on the image of the barcode value, default is true. | [optional]
|
|
268
369
|
|
|
269
370
|
### Return type
|
|
270
371
|
|
|
@@ -74,11 +74,67 @@ module CloudmersiveBarcodeApiClient
|
|
|
74
74
|
end
|
|
75
75
|
return data, status_code, headers
|
|
76
76
|
end
|
|
77
|
+
# Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
78
|
+
# Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
|
|
79
|
+
# @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
80
|
+
# @param [Hash] opts the optional parameters
|
|
81
|
+
# @return [BarcodeAdvancedScanResult]
|
|
82
|
+
def barcode_scan_image_advanced(image_file, opts = {})
|
|
83
|
+
data, _status_code, _headers = barcode_scan_image_advanced_with_http_info(image_file, opts)
|
|
84
|
+
data
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Advanced AI scan and recognition of an image of one or more barcodes of any type
|
|
88
|
+
# Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
|
|
89
|
+
# @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
90
|
+
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @return [Array<(BarcodeAdvancedScanResult, Fixnum, Hash)>] BarcodeAdvancedScanResult data, response status code and response headers
|
|
92
|
+
def barcode_scan_image_advanced_with_http_info(image_file, opts = {})
|
|
93
|
+
if @api_client.config.debugging
|
|
94
|
+
@api_client.config.logger.debug 'Calling API: BarcodeScanApi.barcode_scan_image_advanced ...'
|
|
95
|
+
end
|
|
96
|
+
# verify the required parameter 'image_file' is set
|
|
97
|
+
if @api_client.config.client_side_validation && image_file.nil?
|
|
98
|
+
fail ArgumentError, "Missing the required parameter 'image_file' when calling BarcodeScanApi.barcode_scan_image_advanced"
|
|
99
|
+
end
|
|
100
|
+
# resource path
|
|
101
|
+
local_var_path = '/barcode/scan/image/advanced'
|
|
102
|
+
|
|
103
|
+
# query parameters
|
|
104
|
+
query_params = {}
|
|
105
|
+
|
|
106
|
+
# header parameters
|
|
107
|
+
header_params = {}
|
|
108
|
+
# HTTP header 'Accept' (if needed)
|
|
109
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
110
|
+
# HTTP header 'Content-Type'
|
|
111
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
112
|
+
|
|
113
|
+
# form parameters
|
|
114
|
+
form_params = {}
|
|
115
|
+
form_params['imageFile'] = image_file
|
|
116
|
+
|
|
117
|
+
# http body (model)
|
|
118
|
+
post_body = nil
|
|
119
|
+
auth_names = ['Apikey']
|
|
120
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
121
|
+
:header_params => header_params,
|
|
122
|
+
:query_params => query_params,
|
|
123
|
+
:form_params => form_params,
|
|
124
|
+
:body => post_body,
|
|
125
|
+
:auth_names => auth_names,
|
|
126
|
+
:return_type => 'BarcodeAdvancedScanResult')
|
|
127
|
+
if @api_client.config.debugging
|
|
128
|
+
@api_client.config.logger.debug "API called: BarcodeScanApi#barcode_scan_image_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
129
|
+
end
|
|
130
|
+
return data, status_code, headers
|
|
131
|
+
end
|
|
77
132
|
# Advanced AI scan and recognition of an image of one or more QR barcodes
|
|
78
|
-
# Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG and JPEG input file formats.
|
|
133
|
+
# Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
|
|
79
134
|
# @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
80
135
|
# @param [Hash] opts the optional parameters
|
|
81
136
|
# @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
|
|
137
|
+
# @option opts [String] :recognition_mode Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition.
|
|
82
138
|
# @return [BarcodeScanQRAdvancedResult]
|
|
83
139
|
def barcode_scan_image_advanced_qr(image_file, opts = {})
|
|
84
140
|
data, _status_code, _headers = barcode_scan_image_advanced_qr_with_http_info(image_file, opts)
|
|
@@ -86,10 +142,11 @@ module CloudmersiveBarcodeApiClient
|
|
|
86
142
|
end
|
|
87
143
|
|
|
88
144
|
# Advanced AI scan and recognition of an image of one or more QR barcodes
|
|
89
|
-
# Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG and JPEG input file formats.
|
|
145
|
+
# Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
|
|
90
146
|
# @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
|
91
147
|
# @param [Hash] opts the optional parameters
|
|
92
148
|
# @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
|
|
149
|
+
# @option opts [String] :recognition_mode Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition.
|
|
93
150
|
# @return [Array<(BarcodeScanQRAdvancedResult, Fixnum, Hash)>] BarcodeScanQRAdvancedResult data, response status code and response headers
|
|
94
151
|
def barcode_scan_image_advanced_qr_with_http_info(image_file, opts = {})
|
|
95
152
|
if @api_client.config.debugging
|
|
@@ -112,6 +169,7 @@ module CloudmersiveBarcodeApiClient
|
|
|
112
169
|
# HTTP header 'Content-Type'
|
|
113
170
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
114
171
|
header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
|
|
172
|
+
header_params[:'recognitionMode'] = opts[:'recognition_mode'] if !opts[:'recognition_mode'].nil?
|
|
115
173
|
|
|
116
174
|
# form parameters
|
|
117
175
|
form_params = {}
|