Package org.openapitools.client.api

Class BarcodeScanApi

java.lang.Object
org.openapitools.client.api.BarcodeScanApi
public class BarcodeScanApi extends Object

  • Constructor Details

    • BarcodeScanApi

      public BarcodeScanApi()

    • BarcodeScanApi

      public BarcodeScanApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • barcodeScanImageCall

      public okhttp3.Call barcodeScanImageCall(File imageFile, ApiCallback _callback) throws ApiException
      Build call for barcodeScanImage
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImage

      public BarcodeScanResult barcodeScanImage(File imageFile) throws ApiException
      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
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      Returns:
      BarcodeScanResult
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageWithHttpInfo

      public ApiResponse<BarcodeScanResult> barcodeScanImageWithHttpInfo(File imageFile) throws ApiException
      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
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      Returns:
      ApiResponse<BarcodeScanResult>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAsync

      public okhttp3.Call barcodeScanImageAsync(File imageFile, ApiCallback<BarcodeScanResult> _callback) throws ApiException
      Scan and recognize an image of a barcode (asynchronously) 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
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedCall

      public okhttp3.Call barcodeScanImageAdvancedCall(File imageFile, ApiCallback _callback) throws ApiException
      Build call for barcodeScanImageAdvanced
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvanced

      public BarcodeAdvancedScanResult barcodeScanImageAdvanced(File imageFile) throws ApiException
      Advanced AI scan and recognition of an image of one or more barcodes of any type Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. 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. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      Returns:
      BarcodeAdvancedScanResult
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedWithHttpInfo

      public ApiResponse<BarcodeAdvancedScanResult> barcodeScanImageAdvancedWithHttpInfo(File imageFile) throws ApiException
      Advanced AI scan and recognition of an image of one or more barcodes of any type Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. 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. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      Returns:
      ApiResponse<BarcodeAdvancedScanResult>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedAsync

      public okhttp3.Call barcodeScanImageAdvancedAsync(File imageFile, ApiCallback<BarcodeAdvancedScanResult> _callback) throws ApiException
      Advanced AI scan and recognition of an image of one or more barcodes of any type (asynchronously) Scan an image or photo of a barcode and return the result with enhanced accuracy, particularlly for low quality inputs using Advanced AI. 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. Uses large model AI. Consumes 100 API calls per image page. For Managed Instance and Private Cloud requires GPU infrastructure. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedQRCall

      public okhttp3.Call barcodeScanImageAdvancedQRCall(File imageFile, String preprocessing, String recognitionMode, ApiCallback _callback) throws ApiException
      Build call for barcodeScanImageAdvancedQR
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      preprocessing - Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. (optional)
      recognitionMode - Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedQR

      public BarcodeScanQRAdvancedResult barcodeScanImageAdvancedQR(File imageFile, String preprocessing, String recognitionMode) throws ApiException
      Advanced AI scan and recognition of an image of one or more QR barcodes Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      preprocessing - Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. (optional)
      recognitionMode - Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition. (optional)
      Returns:
      BarcodeScanQRAdvancedResult
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedQRWithHttpInfo

      public ApiResponse<BarcodeScanQRAdvancedResult> barcodeScanImageAdvancedQRWithHttpInfo(File imageFile, String preprocessing, String recognitionMode) throws ApiException
      Advanced AI scan and recognition of an image of one or more QR barcodes Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      preprocessing - Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. (optional)
      recognitionMode - Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition. (optional)
      Returns:
      ApiResponse<BarcodeScanQRAdvancedResult>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • barcodeScanImageAdvancedQRAsync

      public okhttp3.Call barcodeScanImageAdvancedQRAsync(File imageFile, String preprocessing, String recognitionMode, ApiCallback<BarcodeScanQRAdvancedResult> _callback) throws ApiException
      Advanced AI scan and recognition of an image of one or more QR barcodes (asynchronously) Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.
      Parameters:
      imageFile - Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. (required)
      preprocessing - Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement. (optional)
      recognitionMode - Optional, recognitionMode mode, default is 'Advanced'. Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -