cloudmersive-barcode-api-client 2.0.1 → 2.0.2

data/docs/ProductMatch.md

@@ -0,0 +1,9 @@
+# CloudmersiveBarcodeApiClient::ProductMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ean** | **String** | EAN code for the product | [optional] 
+**title** | **String** | Title of the product | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/cloudmersive-barcode-api-client.rb

@@ -0,0 +1,45 @@
+=begin
+#barcodeapi
+
+#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-barcode-api-client/api_client'
+require 'cloudmersive-barcode-api-client/api_error'
+require 'cloudmersive-barcode-api-client/version'
+require 'cloudmersive-barcode-api-client/configuration'
+
+# Models
+require 'cloudmersive-barcode-api-client/models/barcode_lookup_response'
+require 'cloudmersive-barcode-api-client/models/barcode_scan_result'
+require 'cloudmersive-barcode-api-client/models/product_match'
+
+# APIs
+require 'cloudmersive-barcode-api-client/api/barcode_lookup_api'
+require 'cloudmersive-barcode-api-client/api/barcode_scan_api'
+require 'cloudmersive-barcode-api-client/api/generate_barcode_api'
+
+module CloudmersiveBarcodeApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveBarcodeApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/cloudmersive-barcode-api-client/api/barcode_lookup_api.rb

@@ -0,0 +1,77 @@
+=begin
+#barcodeapi
+
+#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveBarcodeApiClient
+  class BarcodeLookupApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Lookup EAN barcode value, return product data
+    # Lookup an input EAN barcode and return key details about the product
+    # @param value Barcode value
+    # @param [Hash] opts the optional parameters
+    # @return [BarcodeLookupResponse]
+    def barcode_lookup_ean_lookup(value, opts = {})
+      data, _status_code, _headers = barcode_lookup_ean_lookup_with_http_info(value, opts)
+      data
+    end
+
+    # Lookup EAN barcode value, return product data
+    # Lookup an input EAN barcode and return key details about the product
+    # @param value Barcode value
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BarcodeLookupResponse, Fixnum, Hash)>] BarcodeLookupResponse data, response status code and response headers
+    def barcode_lookup_ean_lookup_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BarcodeLookupApi.barcode_lookup_ean_lookup ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling BarcodeLookupApi.barcode_lookup_ean_lookup"
+      end
+      # resource path
+      local_var_path = '/barcode/lookup/ean'
+
+      # 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(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'BarcodeLookupResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BarcodeLookupApi#barcode_lookup_ean_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb

@@ -0,0 +1,78 @@
+=begin
+#barcodeapi
+
+#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveBarcodeApiClient
+  class BarcodeScanApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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
+    # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [BarcodeScanResult]
+    def barcode_scan_image(image_file, opts = {})
+      data, _status_code, _headers = barcode_scan_image_with_http_info(image_file, opts)
+      data
+    end
+
+    # 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
+    # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BarcodeScanResult, Fixnum, Hash)>] BarcodeScanResult data, response status code and response headers
+    def barcode_scan_image_with_http_info(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
+  end
+end

data/lib/cloudmersive-barcode-api-client/api/generate_barcode_api.rb

@@ -0,0 +1,293 @@
+=begin
+#barcodeapi
+
+#Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveBarcodeApiClient
+  class GenerateBarcodeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Generate a EAN-13 code barcode as PNG file
+    # Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
+    # @param value Barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def generate_barcode_ean13(value, opts = {})
+      data, _status_code, _headers = generate_barcode_ean13_with_http_info(value, opts)
+      data
+    end
+
+    # Generate a EAN-13 code barcode as PNG file
+    # Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode
+    # @param value Barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def generate_barcode_ean13_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateBarcodeApi.generate_barcode_ean13 ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling GenerateBarcodeApi.generate_barcode_ean13"
+      end
+      # resource path
+      local_var_path = '/barcode/generate/ean-13'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GenerateBarcodeApi#generate_barcode_ean13\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Generate a EAN-8 code barcode as PNG file
+    # Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
+    # @param value Barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def generate_barcode_ean8(value, opts = {})
+      data, _status_code, _headers = generate_barcode_ean8_with_http_info(value, opts)
+      data
+    end
+
+    # Generate a EAN-8 code barcode as PNG file
+    # Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode
+    # @param value Barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def generate_barcode_ean8_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateBarcodeApi.generate_barcode_ean8 ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling GenerateBarcodeApi.generate_barcode_ean8"
+      end
+      # resource path
+      local_var_path = '/barcode/generate/ean-8'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GenerateBarcodeApi#generate_barcode_ean8\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Generate a QR code barcode as PNG file
+    # Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
+    # @param value QR code text to convert into the QR code barcode
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def generate_barcode_qr_code(value, opts = {})
+      data, _status_code, _headers = generate_barcode_qr_code_with_http_info(value, opts)
+      data
+    end
+
+    # Generate a QR code barcode as PNG file
+    # Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information
+    # @param value QR code text to convert into the QR code barcode
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def generate_barcode_qr_code_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateBarcodeApi.generate_barcode_qr_code ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling GenerateBarcodeApi.generate_barcode_qr_code"
+      end
+      # resource path
+      local_var_path = '/barcode/generate/qrcode'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GenerateBarcodeApi#generate_barcode_qr_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Generate a UPC-A code barcode as PNG file
+    # Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
+    # @param value UPC-A barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def generate_barcode_upca(value, opts = {})
+      data, _status_code, _headers = generate_barcode_upca_with_http_info(value, opts)
+      data
+    end
+
+    # Generate a UPC-A code barcode as PNG file
+    # Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode
+    # @param value UPC-A barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def generate_barcode_upca_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateBarcodeApi.generate_barcode_upca ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling GenerateBarcodeApi.generate_barcode_upca"
+      end
+      # resource path
+      local_var_path = '/barcode/generate/upc-a'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GenerateBarcodeApi#generate_barcode_upca\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Generate a UPC-E code barcode as PNG file
+    # Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
+    # @param value UPC-E barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def generate_barcode_upce(value, opts = {})
+      data, _status_code, _headers = generate_barcode_upce_with_http_info(value, opts)
+      data
+    end
+
+    # Generate a UPC-E code barcode as PNG file
+    # Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode
+    # @param value UPC-E barcode value to generate from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def generate_barcode_upce_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateBarcodeApi.generate_barcode_upce ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling GenerateBarcodeApi.generate_barcode_upce"
+      end
+      # resource path
+      local_var_path = '/barcode/generate/upc-e'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['image/png'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GenerateBarcodeApi#generate_barcode_upce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end