Class: CloudmersiveBarcodeApiClient::BarcodeScanApi
- Inherits:
-
Object
- Object
- CloudmersiveBarcodeApiClient::BarcodeScanApi
- Defined in:
- lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#barcode_scan_image(image_file, opts = {}) ⇒ BarcodeScanResult
Scan and recognize an image of a barcode Scan an image or photo of a barcode and return the result.
-
#barcode_scan_image_with_http_info(image_file, opts = {}) ⇒ Array<(BarcodeScanResult, Fixnum, Hash)>
Scan and recognize an image of a barcode Scan an image or photo of a barcode and return the result.
-
#initialize(api_client = ApiClient.default) ⇒ BarcodeScanApi
constructor
A new instance of BarcodeScanApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BarcodeScanApi
Returns a new instance of BarcodeScanApi.
19 20 21 |
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#barcode_scan_image(image_file, opts = {}) ⇒ BarcodeScanResult
Scan and recognize an image of a barcode 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
27 28 29 30 |
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 27 def (image_file, opts = {}) data, _status_code, _headers = (image_file, opts) data end |
#barcode_scan_image_with_http_info(image_file, opts = {}) ⇒ Array<(BarcodeScanResult, Fixnum, Hash)>
Scan and recognize an image of a barcode 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
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 37 def (image_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BarcodeScanApi.barcode_scan_image ...' end # verify the required parameter 'image_file' is set if @api_client.config.client_side_validation && image_file.nil? fail ArgumentError, "Missing the required parameter 'image_file' when calling BarcodeScanApi.barcode_scan_image" end # resource path local_var_path = '/barcode/scan/image' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params['imageFile'] = image_file # http body (model) post_body = nil auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'BarcodeScanResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: BarcodeScanApi#barcode_scan_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |