/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
/// Generated from xplatforms/schemas/document_scanner/Check.yaml

import { ScanbotCheckImpl } from './impl';
import { ImageInput, ResultWrapper } from './types/base/customTypes';
import {
  CheckScannerConfiguration,
  CheckScanningResult,
} from './types/core/check/CheckScannerTypes';
import { CheckScannerScreenConfiguration } from './types/core/ui_v2/check/CheckScannerScreenConfiguration';
import { CheckScannerUiResult } from './types/core/ui_v2/check/CheckScannerUiResult';

/**
 * Entry point for all Check scanning features.
 */
export const ScanbotCheck = {
  /**
   * Opens the Ready-To-Use UI Check scanner with the desired configuration.
   * @param {CheckScannerScreenConfiguration} configuration - The Check scanner configuration to be used for scanning.
   * @returns {Promise<ResultWrapper<CheckScannerUiResult>>} - The result of the Check scanning operation.
   */
  async startScanner(
    configuration: CheckScannerScreenConfiguration
  ): Promise<ResultWrapper<CheckScannerUiResult>> {
    return ScanbotCheckImpl.startScanner(configuration);
  },
  /**
   * Scans Check from a given image with the desired configuration.
   * @param {ImageInput} params.image - The image to be used for scanning.
   * @param {CheckScannerConfiguration} params.configuration - The Check scanner configuration to be used for scanning.
   * @returns {Promise<CheckScanningResult>} - The result of the Check scanning operation.
   */
  async scanFromImage(params: {
    image: ImageInput;
    configuration: CheckScannerConfiguration;
  }): Promise<CheckScanningResult> {
    return ScanbotCheckImpl.scanFromImage(params);
  },
};