cloudmersive-barcode-api-client 2.0.1 → 2.0.2
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/Gemfile +7 -0
- data/README.md +110 -0
- data/Rakefile +8 -0
- data/cloudmersive-barcode-api-client.gemspec +45 -0
- data/docs/BarcodeLookupApi.md +63 -0
- data/docs/BarcodeLookupResponse.md +9 -0
- data/docs/BarcodeScanApi.md +63 -0
- data/docs/BarcodeScanResult.md +10 -0
- data/docs/GenerateBarcodeApi.md +283 -0
- data/docs/ProductMatch.md +9 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-barcode-api-client.rb +45 -0
- data/lib/cloudmersive-barcode-api-client/api/barcode_lookup_api.rb +77 -0
- data/lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb +78 -0
- data/lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb +293 -0
- data/lib/cloudmersive-barcode-api-client/api_client.rb +391 -0
- data/lib/cloudmersive-barcode-api-client/api_error.rb +38 -0
- data/lib/cloudmersive-barcode-api-client/configuration.rb +209 -0
- data/lib/cloudmersive-barcode-api-client/models/barcode_lookup_response.rb +198 -0
- data/lib/cloudmersive-barcode-api-client/models/barcode_scan_result.rb +206 -0
- data/lib/cloudmersive-barcode-api-client/models/product_match.rb +196 -0
- data/lib/cloudmersive-barcode-api-client/version.rb +15 -0
- data/spec/api/barcode_lookup_api_spec.rb +47 -0
- data/spec/api/barcode_scan_api_spec.rb +47 -0
- data/spec/api/generate_barcode_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/barcode_lookup_response_spec.rb +47 -0
- data/spec/models/barcode_scan_result_spec.rb +53 -0
- data/spec/models/product_match_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- metadata +34 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a3f4b5fa446a6650e5537260094fceccf3b3882033fea9f1491a8084e6bb7537
|
4
|
+
data.tar.gz: 357301368e4ff6a7f8cdb4b4417c77e36b2991220a294cf9a7e212aacfeb314d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0ab222d85f2b2d40e8c125a53f2adf401c7b63e0170e9709fc7f34afc421afd604aa22d99f198d0fa9a441aec377ae9bb484332b0a101e6034429f04d3f69d66
|
7
|
+
data.tar.gz: c4c80b4a8791918b242c8cd0176201df023b725efc4de9efb1d538bb7207298e61fe60f9d25c1859c6c5c591f82bde1e7c793fb2b9797c3d79d07e70e0f0ac24
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,110 @@
|
|
1
|
+
# cloudmersive-barcode-api-client
|
2
|
+
|
3
|
+
CloudmersiveBarcodeApiClient - the Ruby gem for the barcodeapi
|
4
|
+
|
5
|
+
Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: v1
|
10
|
+
- Package version: 2.0.2
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build cloudmersive-barcode-api-client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./cloudmersive-barcode-api-client-2.0.2.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-barcode-api-client-2.0.2.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'cloudmersive-barcode-api-client', '~> 2.0.2'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'cloudmersive-barcode-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'cloudmersive-barcode-api-client'
|
56
|
+
|
57
|
+
# Setup authorization
|
58
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
59
|
+
# Configure API key authorization: Apikey
|
60
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = CloudmersiveBarcodeApiClient::BarcodeLookupApi.new
|
66
|
+
|
67
|
+
value = 'value_example' # String | Barcode value
|
68
|
+
|
69
|
+
|
70
|
+
begin
|
71
|
+
#Lookup EAN barcode value, return product data
|
72
|
+
result = api_instance.barcode_lookup_ean_lookup(value)
|
73
|
+
p result
|
74
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
75
|
+
puts "Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: #{e}"
|
76
|
+
end
|
77
|
+
|
78
|
+
```
|
79
|
+
|
80
|
+
## Documentation for API Endpoints
|
81
|
+
|
82
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
83
|
+
|
84
|
+
Class | Method | HTTP request | Description
|
85
|
+
------------ | ------------- | ------------- | -------------
|
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
|
+
*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::GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
|
89
|
+
*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
|
90
|
+
*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
|
91
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upca**](docs/GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
|
92
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upce**](docs/GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
|
93
|
+
|
94
|
+
|
95
|
+
## Documentation for Models
|
96
|
+
|
97
|
+
- [CloudmersiveBarcodeApiClient::BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
|
98
|
+
- [CloudmersiveBarcodeApiClient::BarcodeScanResult](docs/BarcodeScanResult.md)
|
99
|
+
- [CloudmersiveBarcodeApiClient::ProductMatch](docs/ProductMatch.md)
|
100
|
+
|
101
|
+
|
102
|
+
## Documentation for Authorization
|
103
|
+
|
104
|
+
|
105
|
+
### Apikey
|
106
|
+
|
107
|
+
- **Type**: API key
|
108
|
+
- **API key parameter name**: Apikey
|
109
|
+
- **Location**: HTTP header
|
110
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#barcodeapi
|
5
|
+
|
6
|
+
#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
|
7
|
+
|
8
|
+
OpenAPI spec version: v1
|
9
|
+
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
Swagger Codegen version: 2.4.14
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "cloudmersive-barcode-api-client/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "cloudmersive-barcode-api-client"
|
20
|
+
s.version = CloudmersiveBarcodeApiClient::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["Cloudmersive"]
|
23
|
+
s.email = [""]
|
24
|
+
s.homepage = "https://www.cloudmersive.com/barcode-api"
|
25
|
+
s.summary = "Generate and recognize 1D and 2D barcodes."
|
26
|
+
s.description = "Generate and recognize 1D and 2D barcodes."
|
27
|
+
s.license = 'Apache 2.0'
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
35
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
36
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
37
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
38
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
39
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
40
|
+
|
41
|
+
s.files = Dir['./**/*']
|
42
|
+
s.test_files = `find spec/*`.split("\n")
|
43
|
+
s.executables = []
|
44
|
+
s.require_paths = ["lib"]
|
45
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeLookupApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**barcode_lookup_ean_lookup**](BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
|
8
|
+
|
9
|
+
|
10
|
+
# **barcode_lookup_ean_lookup**
|
11
|
+
> BarcodeLookupResponse barcode_lookup_ean_lookup(value)
|
12
|
+
|
13
|
+
Lookup EAN barcode value, return product data
|
14
|
+
|
15
|
+
Lookup an input EAN barcode and return key details about the product
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-barcode-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveBarcodeApiClient::BarcodeLookupApi.new
|
30
|
+
|
31
|
+
value = 'value_example' # String | Barcode value
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Lookup EAN barcode value, return product data
|
36
|
+
result = api_instance.barcode_lookup_ean_lookup(value)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
39
|
+
puts "Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**value** | **String**| Barcode value |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**BarcodeLookupResponse**](BarcodeLookupResponse.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeLookupResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if operation was successful, false otherwise | [optional]
|
7
|
+
**matches** | [**Array<ProductMatch>**](ProductMatch.md) | Resulting product matches for the input barcode | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeScanApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**barcode_scan_image**](BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
|
8
|
+
|
9
|
+
|
10
|
+
# **barcode_scan_image**
|
11
|
+
> BarcodeScanResult barcode_scan_image(image_file)
|
12
|
+
|
13
|
+
Scan and recognize an image of a barcode
|
14
|
+
|
15
|
+
Scan an image or photo of a barcode and return the result. 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
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-barcode-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveBarcodeApiClient::BarcodeScanApi.new
|
30
|
+
|
31
|
+
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.
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Scan and recognize an image of a barcode
|
36
|
+
result = api_instance.barcode_scan_image(image_file)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
39
|
+
puts "Exception when calling BarcodeScanApi->barcode_scan_image: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**BarcodeScanResult**](BarcodeScanResult.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: multipart/form-data
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeScanResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**barcode_type** | **String** | The type of the barcode; possible values are 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
|
+
**raw_text** | **String** | The barcode text | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,283 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::GenerateBarcodeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**generate_barcode_ean13**](GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
|
8
|
+
[**generate_barcode_ean8**](GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
|
9
|
+
[**generate_barcode_qr_code**](GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
|
10
|
+
[**generate_barcode_upca**](GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
|
11
|
+
[**generate_barcode_upce**](GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
|
12
|
+
|
13
|
+
|
14
|
+
# **generate_barcode_ean13**
|
15
|
+
> File generate_barcode_ean13(value)
|
16
|
+
|
17
|
+
Generate a EAN-13 code barcode as PNG file
|
18
|
+
|
19
|
+
Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'cloudmersive-barcode-api-client'
|
25
|
+
# setup authorization
|
26
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
27
|
+
# Configure API key authorization: Apikey
|
28
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
34
|
+
|
35
|
+
value = 'value_example' # String | Barcode value to generate from
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
#Generate a EAN-13 code barcode as PNG file
|
40
|
+
result = api_instance.generate_barcode_ean13(value)
|
41
|
+
p result
|
42
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
43
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean13: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
Name | Type | Description | Notes
|
50
|
+
------------- | ------------- | ------------- | -------------
|
51
|
+
**value** | **String**| Barcode value to generate from |
|
52
|
+
|
53
|
+
### Return type
|
54
|
+
|
55
|
+
**File**
|
56
|
+
|
57
|
+
### Authorization
|
58
|
+
|
59
|
+
[Apikey](../README.md#Apikey)
|
60
|
+
|
61
|
+
### HTTP request headers
|
62
|
+
|
63
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
64
|
+
- **Accept**: image/png
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
# **generate_barcode_ean8**
|
69
|
+
> File generate_barcode_ean8(value)
|
70
|
+
|
71
|
+
Generate a EAN-8 code barcode as PNG file
|
72
|
+
|
73
|
+
Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
|
74
|
+
|
75
|
+
### Example
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'cloudmersive-barcode-api-client'
|
79
|
+
# setup authorization
|
80
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
81
|
+
# Configure API key authorization: Apikey
|
82
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
83
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
88
|
+
|
89
|
+
value = 'value_example' # String | Barcode value to generate from
|
90
|
+
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Generate a EAN-8 code barcode as PNG file
|
94
|
+
result = api_instance.generate_barcode_ean8(value)
|
95
|
+
p result
|
96
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
97
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean8: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**value** | **String**| Barcode value to generate from |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
**File**
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[Apikey](../README.md#Apikey)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
118
|
+
- **Accept**: image/png
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
# **generate_barcode_qr_code**
|
123
|
+
> File generate_barcode_qr_code(value)
|
124
|
+
|
125
|
+
Generate a QR code barcode as PNG file
|
126
|
+
|
127
|
+
Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
|
128
|
+
|
129
|
+
### Example
|
130
|
+
```ruby
|
131
|
+
# load the gem
|
132
|
+
require 'cloudmersive-barcode-api-client'
|
133
|
+
# setup authorization
|
134
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
135
|
+
# Configure API key authorization: Apikey
|
136
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
138
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
139
|
+
end
|
140
|
+
|
141
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
142
|
+
|
143
|
+
value = 'value_example' # String | QR code text to convert into the QR code barcode
|
144
|
+
|
145
|
+
|
146
|
+
begin
|
147
|
+
#Generate a QR code barcode as PNG file
|
148
|
+
result = api_instance.generate_barcode_qr_code(value)
|
149
|
+
p result
|
150
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
151
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_qr_code: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
Name | Type | Description | Notes
|
158
|
+
------------- | ------------- | ------------- | -------------
|
159
|
+
**value** | **String**| QR code text to convert into the QR code barcode |
|
160
|
+
|
161
|
+
### Return type
|
162
|
+
|
163
|
+
**File**
|
164
|
+
|
165
|
+
### Authorization
|
166
|
+
|
167
|
+
[Apikey](../README.md#Apikey)
|
168
|
+
|
169
|
+
### HTTP request headers
|
170
|
+
|
171
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
172
|
+
- **Accept**: image/png
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
# **generate_barcode_upca**
|
177
|
+
> File generate_barcode_upca(value)
|
178
|
+
|
179
|
+
Generate a UPC-A code barcode as PNG file
|
180
|
+
|
181
|
+
Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
|
182
|
+
|
183
|
+
### Example
|
184
|
+
```ruby
|
185
|
+
# load the gem
|
186
|
+
require 'cloudmersive-barcode-api-client'
|
187
|
+
# setup authorization
|
188
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
189
|
+
# Configure API key authorization: Apikey
|
190
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
192
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
193
|
+
end
|
194
|
+
|
195
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
196
|
+
|
197
|
+
value = 'value_example' # String | UPC-A barcode value to generate from
|
198
|
+
|
199
|
+
|
200
|
+
begin
|
201
|
+
#Generate a UPC-A code barcode as PNG file
|
202
|
+
result = api_instance.generate_barcode_upca(value)
|
203
|
+
p result
|
204
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
205
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upca: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
### Parameters
|
210
|
+
|
211
|
+
Name | Type | Description | Notes
|
212
|
+
------------- | ------------- | ------------- | -------------
|
213
|
+
**value** | **String**| UPC-A barcode value to generate from |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
**File**
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
[Apikey](../README.md#Apikey)
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
226
|
+
- **Accept**: image/png
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
# **generate_barcode_upce**
|
231
|
+
> File generate_barcode_upce(value)
|
232
|
+
|
233
|
+
Generate a UPC-E code barcode as PNG file
|
234
|
+
|
235
|
+
Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
|
236
|
+
|
237
|
+
### Example
|
238
|
+
```ruby
|
239
|
+
# load the gem
|
240
|
+
require 'cloudmersive-barcode-api-client'
|
241
|
+
# setup authorization
|
242
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
243
|
+
# Configure API key authorization: Apikey
|
244
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
245
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
246
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
247
|
+
end
|
248
|
+
|
249
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
250
|
+
|
251
|
+
value = 'value_example' # String | UPC-E barcode value to generate from
|
252
|
+
|
253
|
+
|
254
|
+
begin
|
255
|
+
#Generate a UPC-E code barcode as PNG file
|
256
|
+
result = api_instance.generate_barcode_upce(value)
|
257
|
+
p result
|
258
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
259
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upce: #{e}"
|
260
|
+
end
|
261
|
+
```
|
262
|
+
|
263
|
+
### Parameters
|
264
|
+
|
265
|
+
Name | Type | Description | Notes
|
266
|
+
------------- | ------------- | ------------- | -------------
|
267
|
+
**value** | **String**| UPC-E barcode value to generate from |
|
268
|
+
|
269
|
+
### Return type
|
270
|
+
|
271
|
+
**File**
|
272
|
+
|
273
|
+
### Authorization
|
274
|
+
|
275
|
+
[Apikey](../README.md#Apikey)
|
276
|
+
|
277
|
+
### HTTP request headers
|
278
|
+
|
279
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
280
|
+
- **Accept**: image/png
|
281
|
+
|
282
|
+
|
283
|
+
|