cloudmersive-barcode-api-client 1.3.0 → 2.0.1

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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. metadata +3 -34
  3. data/Gemfile +0 -7
  4. data/README.md +0 -110
  5. data/Rakefile +0 -8
  6. data/cloudmersive-barcode-api-client.gemspec +0 -45
  7. data/docs/BarcodeLookupApi.md +0 -61
  8. data/docs/BarcodeLookupResponse.md +0 -9
  9. data/docs/BarcodeScanApi.md +0 -61
  10. data/docs/BarcodeScanResult.md +0 -10
  11. data/docs/GenerateBarcodeApi.md +0 -273
  12. data/docs/ProductMatch.md +0 -9
  13. data/git_push.sh +0 -55
  14. data/lib/cloudmersive-barcode-api-client.rb +0 -45
  15. data/lib/cloudmersive-barcode-api-client/api/barcode_lookup_api.rb +0 -78
  16. data/lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb +0 -79
  17. data/lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb +0 -298
  18. data/lib/cloudmersive-barcode-api-client/api_client.rb +0 -389
  19. data/lib/cloudmersive-barcode-api-client/api_error.rb +0 -38
  20. data/lib/cloudmersive-barcode-api-client/configuration.rb +0 -209
  21. data/lib/cloudmersive-barcode-api-client/models/barcode_lookup_response.rb +0 -201
  22. data/lib/cloudmersive-barcode-api-client/models/barcode_scan_result.rb +0 -209
  23. data/lib/cloudmersive-barcode-api-client/models/product_match.rb +0 -199
  24. data/lib/cloudmersive-barcode-api-client/version.rb +0 -15
  25. data/spec/api/barcode_lookup_api_spec.rb +0 -47
  26. data/spec/api/barcode_scan_api_spec.rb +0 -47
  27. data/spec/api/generate_barcode_api_spec.rb +0 -95
  28. data/spec/api_client_spec.rb +0 -226
  29. data/spec/configuration_spec.rb +0 -42
  30. data/spec/models/barcode_lookup_response_spec.rb +0 -48
  31. data/spec/models/barcode_scan_result_spec.rb +0 -54
  32. data/spec/models/product_match_spec.rb +0 -48
  33. data/spec/spec_helper.rb +0 -111
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1f453a74eefd9d6c19bd65ca96f006457960fd639a9a9c753be1ee63b8ba7371
4
- data.tar.gz: 588b5840b9d07a2ab445bf54eb1049df01db55b45d7ff3b4e9ce3b3962d3d121
3
+ metadata.gz: cc82e32c02d0e4ccc8b1a79e18525212799cea62dfeddb58e1eb23f016136e34
4
+ data.tar.gz: f61d32c9f37bf8979b083f87517150ff82d5475b231b3aceca5e326b04647da6
5
5
  SHA512:
6
- metadata.gz: 3c771dc4e9b82545a5d1181d2f0901ade75d1b4ec57fd20f326ee8a80f041716378712f3e1318b262364f612a2943bccf3ddf66198375d8631e0d835ce18d9ae
7
- data.tar.gz: db59fe5fbc13d1097be0507e8ea2e6b07d848ab18a2719dfbadf4eb9338639d79dc2d3e611082197c7e6b0ce981b9c9ce5279290414e37ef51008072294c3b9d
6
+ metadata.gz: ffa0f2156f966b5ba103d9f5efcbe518c7a7e83cf40adc48560574a82c05c49188327075b517f8518c1ead4ea6070c5c56b7231325947ab1cf57facb1a43ca5a
7
+ data.tar.gz: 6a82a159a0e9402f5e36ef13405e909f270e375785189b0f2b4f098d507334bcb746491c7c5b8e54d86e8ba19f38f60c74809479a487ee55903c9a6de651d900
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudmersive-barcode-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 2.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-18 00:00:00.000000000 Z
11
+ date: 2020-05-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -196,38 +196,7 @@ email:
196
196
  executables: []
197
197
  extensions: []
198
198
  extra_rdoc_files: []
199
- files:
200
- - "./Gemfile"
201
- - "./README.md"
202
- - "./Rakefile"
203
- - "./cloudmersive-barcode-api-client.gemspec"
204
- - "./docs/BarcodeLookupApi.md"
205
- - "./docs/BarcodeLookupResponse.md"
206
- - "./docs/BarcodeScanApi.md"
207
- - "./docs/BarcodeScanResult.md"
208
- - "./docs/GenerateBarcodeApi.md"
209
- - "./docs/ProductMatch.md"
210
- - "./git_push.sh"
211
- - "./lib/cloudmersive-barcode-api-client.rb"
212
- - "./lib/cloudmersive-barcode-api-client/api/barcode_lookup_api.rb"
213
- - "./lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb"
214
- - "./lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb"
215
- - "./lib/cloudmersive-barcode-api-client/api_client.rb"
216
- - "./lib/cloudmersive-barcode-api-client/api_error.rb"
217
- - "./lib/cloudmersive-barcode-api-client/configuration.rb"
218
- - "./lib/cloudmersive-barcode-api-client/models/barcode_lookup_response.rb"
219
- - "./lib/cloudmersive-barcode-api-client/models/barcode_scan_result.rb"
220
- - "./lib/cloudmersive-barcode-api-client/models/product_match.rb"
221
- - "./lib/cloudmersive-barcode-api-client/version.rb"
222
- - "./spec/api/barcode_lookup_api_spec.rb"
223
- - "./spec/api/barcode_scan_api_spec.rb"
224
- - "./spec/api/generate_barcode_api_spec.rb"
225
- - "./spec/api_client_spec.rb"
226
- - "./spec/configuration_spec.rb"
227
- - "./spec/models/barcode_lookup_response_spec.rb"
228
- - "./spec/models/barcode_scan_result_spec.rb"
229
- - "./spec/models/product_match_spec.rb"
230
- - "./spec/spec_helper.rb"
199
+ files: []
231
200
  homepage: https://www.cloudmersive.com/barcode-api
232
201
  licenses:
233
202
  - Apache 2.0
data/Gemfile DELETED
@@ -1,7 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- gemspec
4
-
5
- group :development, :test do
6
- gem 'rake', '~> 12.0.0'
7
- end
data/README.md DELETED
@@ -1,110 +0,0 @@
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.3.0
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.3.0.gem
27
- ```
28
- (for development, run `gem install --dev ./cloudmersive-barcode-api-client-1.3.0.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.3.0'
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::BarcodeScanApi* | [**barcode_scan_image**](docs/BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan an image for a barcode and turn 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
88
- *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
89
- *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
90
- *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
91
- *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
92
- *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
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 DELETED
@@ -1,8 +0,0 @@
1
- begin
2
- require 'rspec/core/rake_task'
3
-
4
- RSpec::Core::RakeTask.new(:spec)
5
- task default: :spec
6
- rescue LoadError
7
- # no rspec available
8
- end
@@ -1,45 +0,0 @@
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.3.1
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
@@ -1,61 +0,0 @@
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
-
@@ -1,9 +0,0 @@
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
-
@@ -1,61 +0,0 @@
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 an image for a barcode and turn 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
8
-
9
-
10
- # **barcode_scan_image**
11
- > BarcodeScanResult barcode_scan_image(image_file)
12
-
13
- Scan an image for a barcode and turn 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
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::BarcodeScanApi.new
28
-
29
- 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.
30
-
31
-
32
- begin
33
- #Scan an image for a barcode and turn 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
34
- result = api_instance.barcode_scan_image(image_file)
35
- p result
36
- rescue CloudmersiveBarcodeApiClient::ApiError => e
37
- puts "Exception when calling BarcodeScanApi->barcode_scan_image: #{e}"
38
- end
39
- ```
40
-
41
- ### Parameters
42
-
43
- Name | Type | Description | Notes
44
- ------------- | ------------- | ------------- | -------------
45
- **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
46
-
47
- ### Return type
48
-
49
- [**BarcodeScanResult**](BarcodeScanResult.md)
50
-
51
- ### Authorization
52
-
53
- [Apikey](../README.md#Apikey)
54
-
55
- ### HTTP request headers
56
-
57
- - **Content-Type**: multipart/form-data
58
- - **Accept**: application/json, text/json, application/xml, text/xml
59
-
60
-
61
-
@@ -1,10 +0,0 @@
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
-
@@ -1,273 +0,0 @@
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
-