react-native-scanbot-sdk/lib/typescript/src/credit_card/CreditCardTypes.d.ts

Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS

import { DocumentDetectionStatus } from '../document_scanner/DocumentScannerTypes';
import { GenericDocument } from '../documents/GenericDocument';
import { ResultAccumulationConfiguration } from '../frame_accumulation/FrameAccumulationTypes';
import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
import { DeepPartial, PartiallyConstructible, Point } from '../utils/utils';
/**
The status of the scanning process.

- `SUCCESS`:
   The credit card was scanned successfully.
- `ERROR_NOTHING_FOUND`:
   No credit card was detected.
- `INCOMPLETE`:
   Not all required fields were found or confirmed.
*/
export type CreditCardScanningStatus = 'SUCCESS' | 'ERROR_NOTHING_FOUND' | 'INCOMPLETE';
export declare const CreditCardScanningStatusValues: CreditCardScanningStatus[];
/**
Contains the result of running the credit card scanner.
*/
export declare class CreditCardScanningResult extends PartiallyConstructible {
    /**
      The status of the credit card detection step.
      */
    readonly detectionStatus: DocumentDetectionStatus;
    /**
      The status of the credit card scanning step.
      */
    readonly scanningStatus: CreditCardScanningStatus;
    /**
      Generic document containing credit card data. Not present, if status is FAIL.
      */
    readonly creditCard: GenericDocument | null;
    /**
      Coordinates of the detected credit card in the input image (clockwise from top-left).
      */
    readonly quad: Point[];
    /**
      Coordinates of the detected credit card in the input image (clockwise from top-left), normalized to the range [0, 1].
      */
    readonly quadNormalized: Point[];
    /** @param source {@displayType `DeepPartial<CreditCardScanningResult>`} */
    constructor(source?: DeepPartial<CreditCardScanningResult>);
    serialize(config?: ToJsonConfiguration): Promise<DeepPartial<CreditCardScanningResult>>;
    private _released;
    release(): void;
    encodeImages(): Promise<void>;
}
/**
The scanning mode.

- `LIVE`:
   The scanner will merge all information from multiple frames to provide the best possible result.
   Use this mode when the input is a video or camera stream.
- `SINGLE_SHOT`:
   The scanner will only use the current frame and will spend additional time to ensure the best possible result. Use this mode when scanning single images, e.g. imported from the gallery.
*/
export type CreditCardScanningMode = 'LIVE' | 'SINGLE_SHOT';
export declare const CreditCardScanningModeValues: CreditCardScanningMode[];
/**
Configuration for the credit card scanner.
*/
export declare class CreditCardScannerConfiguration extends PartiallyConstructible {
    /**
      If true, the document detector will be used to find where the credit card is in the input image.
      If false, the scanner will assume that the credit card has been pre-cropped and takes the entirety of the input image.
      
      Default is true
      */
    useDocumentDetector: boolean;
    /**
      The scanning mode.
      
      Default is LIVE
      */
    scanningMode: CreditCardScanningMode;
    /**
      Whether the expiry date is required for a successful scan.
      
      Default is true
      */
    requireExpiryDate: boolean;
    /**
      Whether the cardholder name is required for a successful scan.
      
      Default is true
      */
    requireCardholderName: boolean;
    /**
      Configuration for how to accumulate results.
      */
    resultAccumulationConfig: ResultAccumulationConfiguration;
    /**
      If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
      
      Default is false
      */
    returnCreditCardImage: boolean;
    /** @param source {@displayType `DeepPartial<CreditCardScannerConfiguration>`} */
    constructor(source?: DeepPartial<CreditCardScannerConfiguration>);
}
//# sourceMappingURL=CreditCardTypes.d.ts.map