cloudmersive-barcode-api-client 1.2.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +108 -0
- data/Rakefile +8 -0
- data/cloudmersive-barcode-api-client.gemspec +45 -0
- data/docs/BarcodeLookupApi.md +61 -0
- data/docs/BarcodeLookupResponse.md +9 -0
- data/docs/GenerateBarcodeApi.md +273 -0
- data/docs/ProductMatch.md +9 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-barcode-api-client.rb +43 -0
- data/lib/cloudmersive-barcode-api-client/api/barcode_lookup_api.rb +78 -0
- data/lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb +298 -0
- data/lib/cloudmersive-barcode-api-client/api_client.rb +389 -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 +199 -0
- data/lib/cloudmersive-barcode-api-client/models/product_match.rb +197 -0
- data/lib/cloudmersive-barcode-api-client/version.rb +15 -0
- data/spec/api/barcode_lookup_api_spec.rb +47 -0
- data/spec/api/generate_barcode_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/barcode_lookup_response_spec.rb +48 -0
- data/spec/models/product_match_spec.rb +48 -0
- data/spec/spec_helper.rb +111 -0
- metadata +249 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1c319c2521eef3ae1202220605189fcd4e4ebc6a637e06510487d5067c3e9deb
|
4
|
+
data.tar.gz: b5ef4b448ce2ec293110067f38ae7e8eaf0995b5aac962babcbebcdab9b62da5
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6c426a727e72b6cba173e5b61ecee2a94a68eb1581bcb81d2ce8ffb93a0212bb397ebba6289c4c741045aa872a09a9fffac987a31e2f745b4277b7dff6d8aa72
|
7
|
+
data.tar.gz: 70e1ec98d6cb35d7b684f1d50ae5b3080780d01a66c1d5caee51238e99bf4d64ec62a573badbfbf856c6dc2f2ad6c6546c5d16b93e802fddbbf313e3de354547
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,108 @@
|
|
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: 1.2.9
|
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-1.2.9.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-barcode-api-client-1.2.9.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', '~> 1.2.9'
|
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 a barcode value and 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 a barcode value and return product data
|
87
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
88
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_ean8**](docs/GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
|
89
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_qr_code**](docs/GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
|
90
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upca**](docs/GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
|
91
|
+
*CloudmersiveBarcodeApiClient::GenerateBarcodeApi* | [**generate_barcode_upce**](docs/GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
|
92
|
+
|
93
|
+
|
94
|
+
## Documentation for Models
|
95
|
+
|
96
|
+
- [CloudmersiveBarcodeApiClient::BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
|
97
|
+
- [CloudmersiveBarcodeApiClient::ProductMatch](docs/ProductMatch.md)
|
98
|
+
|
99
|
+
|
100
|
+
## Documentation for Authorization
|
101
|
+
|
102
|
+
|
103
|
+
### Apikey
|
104
|
+
|
105
|
+
- **Type**: API key
|
106
|
+
- **API key parameter name**: Apikey
|
107
|
+
- **Location**: HTTP header
|
108
|
+
|
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: unset
|
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,61 @@
|
|
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 a barcode value and return product data
|
8
|
+
|
9
|
+
|
10
|
+
# **barcode_lookup_ean_lookup**
|
11
|
+
> BarcodeLookupResponse barcode_lookup_ean_lookup(value)
|
12
|
+
|
13
|
+
Lookup a barcode value and return product data
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'cloudmersive-barcode-api-client'
|
19
|
+
# setup authorization
|
20
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
21
|
+
# Configure API key authorization: Apikey
|
22
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
23
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
24
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = CloudmersiveBarcodeApiClient::BarcodeLookupApi.new
|
28
|
+
|
29
|
+
value = "value_example" # String | Barcode value
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Lookup a barcode value and return product data
|
34
|
+
result = api_instance.barcode_lookup_ean_lookup(value)
|
35
|
+
p result
|
36
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
37
|
+
puts "Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**value** | **String**| Barcode value |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**BarcodeLookupResponse**](BarcodeLookupResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
[Apikey](../README.md#Apikey)
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
58
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
59
|
+
|
60
|
+
|
61
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveBarcodeApiClient::BarcodeLookupResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | | [optional]
|
7
|
+
**matches** | [**Array<ProductMatch>**](ProductMatch.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,273 @@
|
|
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 | Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
8
|
+
[**generate_barcode_ean8**](GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
|
9
|
+
[**generate_barcode_qr_code**](GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
|
10
|
+
[**generate_barcode_upca**](GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
|
11
|
+
[**generate_barcode_upce**](GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
|
12
|
+
|
13
|
+
|
14
|
+
# **generate_barcode_ean13**
|
15
|
+
> File generate_barcode_ean13(value)
|
16
|
+
|
17
|
+
Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'cloudmersive-barcode-api-client'
|
23
|
+
# setup authorization
|
24
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
25
|
+
# Configure API key authorization: Apikey
|
26
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
32
|
+
|
33
|
+
value = "value_example" # String | Barcode value to generate from
|
34
|
+
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
|
38
|
+
result = api_instance.generate_barcode_ean13(value)
|
39
|
+
p result
|
40
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
41
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean13: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**value** | **String**| Barcode value to generate from |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
**File**
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[Apikey](../README.md#Apikey)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
62
|
+
- **Accept**: image/png
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **generate_barcode_ean8**
|
67
|
+
> File generate_barcode_ean8(value)
|
68
|
+
|
69
|
+
Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
|
70
|
+
|
71
|
+
### Example
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'cloudmersive-barcode-api-client'
|
75
|
+
# setup authorization
|
76
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
77
|
+
# Configure API key authorization: Apikey
|
78
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
80
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
81
|
+
end
|
82
|
+
|
83
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
84
|
+
|
85
|
+
value = "value_example" # String | Barcode value to generate from
|
86
|
+
|
87
|
+
|
88
|
+
begin
|
89
|
+
#Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
|
90
|
+
result = api_instance.generate_barcode_ean8(value)
|
91
|
+
p result
|
92
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
93
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_ean8: #{e}"
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
### Parameters
|
98
|
+
|
99
|
+
Name | Type | Description | Notes
|
100
|
+
------------- | ------------- | ------------- | -------------
|
101
|
+
**value** | **String**| Barcode value to generate from |
|
102
|
+
|
103
|
+
### Return type
|
104
|
+
|
105
|
+
**File**
|
106
|
+
|
107
|
+
### Authorization
|
108
|
+
|
109
|
+
[Apikey](../README.md#Apikey)
|
110
|
+
|
111
|
+
### HTTP request headers
|
112
|
+
|
113
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
114
|
+
- **Accept**: image/png
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
# **generate_barcode_qr_code**
|
119
|
+
> File generate_barcode_qr_code(value)
|
120
|
+
|
121
|
+
Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
|
122
|
+
|
123
|
+
### Example
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'cloudmersive-barcode-api-client'
|
127
|
+
# setup authorization
|
128
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
129
|
+
# Configure API key authorization: Apikey
|
130
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
131
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
132
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
133
|
+
end
|
134
|
+
|
135
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
136
|
+
|
137
|
+
value = "value_example" # String | QR code text to convert into the QR code barcode
|
138
|
+
|
139
|
+
|
140
|
+
begin
|
141
|
+
#Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
|
142
|
+
result = api_instance.generate_barcode_qr_code(value)
|
143
|
+
p result
|
144
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
145
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_qr_code: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
### Parameters
|
150
|
+
|
151
|
+
Name | Type | Description | Notes
|
152
|
+
------------- | ------------- | ------------- | -------------
|
153
|
+
**value** | **String**| QR code text to convert into the QR code barcode |
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
**File**
|
158
|
+
|
159
|
+
### Authorization
|
160
|
+
|
161
|
+
[Apikey](../README.md#Apikey)
|
162
|
+
|
163
|
+
### HTTP request headers
|
164
|
+
|
165
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
166
|
+
- **Accept**: image/png
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
# **generate_barcode_upca**
|
171
|
+
> File generate_barcode_upca(value)
|
172
|
+
|
173
|
+
Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
|
174
|
+
|
175
|
+
### Example
|
176
|
+
```ruby
|
177
|
+
# load the gem
|
178
|
+
require 'cloudmersive-barcode-api-client'
|
179
|
+
# setup authorization
|
180
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
181
|
+
# Configure API key authorization: Apikey
|
182
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
183
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
184
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
185
|
+
end
|
186
|
+
|
187
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
188
|
+
|
189
|
+
value = "value_example" # String | UPC-A barcode value to generate from
|
190
|
+
|
191
|
+
|
192
|
+
begin
|
193
|
+
#Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
|
194
|
+
result = api_instance.generate_barcode_upca(value)
|
195
|
+
p result
|
196
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
197
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upca: #{e}"
|
198
|
+
end
|
199
|
+
```
|
200
|
+
|
201
|
+
### Parameters
|
202
|
+
|
203
|
+
Name | Type | Description | Notes
|
204
|
+
------------- | ------------- | ------------- | -------------
|
205
|
+
**value** | **String**| UPC-A barcode value to generate from |
|
206
|
+
|
207
|
+
### Return type
|
208
|
+
|
209
|
+
**File**
|
210
|
+
|
211
|
+
### Authorization
|
212
|
+
|
213
|
+
[Apikey](../README.md#Apikey)
|
214
|
+
|
215
|
+
### HTTP request headers
|
216
|
+
|
217
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
218
|
+
- **Accept**: image/png
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
# **generate_barcode_upce**
|
223
|
+
> File generate_barcode_upce(value)
|
224
|
+
|
225
|
+
Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
|
226
|
+
|
227
|
+
### Example
|
228
|
+
```ruby
|
229
|
+
# load the gem
|
230
|
+
require 'cloudmersive-barcode-api-client'
|
231
|
+
# setup authorization
|
232
|
+
CloudmersiveBarcodeApiClient.configure do |config|
|
233
|
+
# Configure API key authorization: Apikey
|
234
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
235
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
236
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
237
|
+
end
|
238
|
+
|
239
|
+
api_instance = CloudmersiveBarcodeApiClient::GenerateBarcodeApi.new
|
240
|
+
|
241
|
+
value = "value_example" # String | UPC-E barcode value to generate from
|
242
|
+
|
243
|
+
|
244
|
+
begin
|
245
|
+
#Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
|
246
|
+
result = api_instance.generate_barcode_upce(value)
|
247
|
+
p result
|
248
|
+
rescue CloudmersiveBarcodeApiClient::ApiError => e
|
249
|
+
puts "Exception when calling GenerateBarcodeApi->generate_barcode_upce: #{e}"
|
250
|
+
end
|
251
|
+
```
|
252
|
+
|
253
|
+
### Parameters
|
254
|
+
|
255
|
+
Name | Type | Description | Notes
|
256
|
+
------------- | ------------- | ------------- | -------------
|
257
|
+
**value** | **String**| UPC-E barcode value to generate from |
|
258
|
+
|
259
|
+
### Return type
|
260
|
+
|
261
|
+
**File**
|
262
|
+
|
263
|
+
### Authorization
|
264
|
+
|
265
|
+
[Apikey](../README.md#Apikey)
|
266
|
+
|
267
|
+
### HTTP request headers
|
268
|
+
|
269
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
270
|
+
- **Accept**: image/png
|
271
|
+
|
272
|
+
|
273
|
+
|