cordova-plugin-scanbot-barcode-scanner/types/types.ts

Cordova Plugin for the Scanbot Barcode Scanner SDK

/** The Barcode Scanner Result Field */
export interface BarcodeResultField {
    /** The recognized barcode type */
    type: BarcodeFormat;

    /** The recognized barcode text */
    text: string;

    /** The recognized barcode text with extension (if available) */
    textWithExtension: string;

    /** The array of raw bytes that compose the recognized barcode */
    rawBytes: number[];

    /** True if the Barcode Document has been parsed successfully */
    parsedSuccessful: boolean;

    /** The formatted barcode document (if it was parsed succesfully) */
    formattedResult?: AAMVADocumentFormat | BoardingPassDocumentFormat | GS1DocumentFormat | IDCardPDF417DocumentFormat | MedicalCertificateDocumentFormat | MedicalPlanDocumentFormat | SEPADocumentFormat | SwissQRCodeDocumentFormat | VCardDocumentFormat;
}

/** Base Document Format */
export interface BaseDocumentFormat {
    /** True if the document was parsed successfully */
    parsedSuccessful: boolean;

    /** The parsed barcode document type */
    documentFormat: BarcodeDocumentFormat;
}

/** AAMVA Document Format */
export interface AAMVADocumentFormat extends BaseDocumentFormat {
    /** Header Raw String */
    headerRawString: string;

    /** File Type */
    fileType: string;

    /** Issuer Identification Number */
    issuerIdentificationNumber: string;

    /** AAMVA Version Number */
    aamvaVersionNumber: string;

    /** Jurisdiction Version Number */
    jurisdictionVersionNumber: string;

    /** Number of entries */
    numberOfEntries: number;

    /** Sub-files */
    subfiles: AAMVADocumentSubfile[];
}

/** AAMVA Document Sub-File */
export interface AAMVADocumentSubfile {
    /** Sub-file type */
    subFileType: string;

    /** Sub-file raw header */
    subFileRawHeader: string;

    /** Sub-file fields */
    fields: AAMVADocumentSubfileField[];
}

/** AAMVA Document Sub-File Field */
export interface AAMVADocumentSubfileField {
    /** AAMVA Document sub-file Record Field Type */
    type: AAMVARecordFieldType;

    /** AAMVA Document sub-file Field Type String */
    typeString: string;

    /** AAMVA Document sub-file Field value */
    value: string;

    /** AAMVA Document sub-file Field raw value */
    rawValue: string;
}

/** AAMVA Record Field Type */
export type AAMVARecordFieldType =
    /** Audit information. */
    | 'AUDIT_INFORMATION'
    /** Card revision date. */
    | 'CARD_REVISION_DATE'
    /** Compliance type. */
    | 'COMPLIANCE_TYPE'
    /** Country of territory of issuance. */
    | 'COUNTRY_TERRITORY_OF_ISSUANCE'
    /** Court restriction code. */
    | 'COURT_RESTRICTION_CODE'
    /** Date of birth. */
    | 'DATE_OF_BIRTH'
    /** Document discriminator. */
    | 'DOCUMENT_DISCRIMINATOR'
    /** Eyes color. */
    | 'EYES_COLOR'
    /** Family name. */
    | 'FAMILY_NAME'
    /** Family name truncation. */
    | 'FAMILY_NAME_TRUNCATION'
    /** Federal commercial vehicle codes. */
    | 'FEDERAL_COMMERCIAL_VEHICLE_CODES'
    /** First name. */
    | 'FIRST_NAME'
    /** First name truncation. */
    | 'FIRST_NAMES_TRUNCATION'
    /** Full name. */
    | 'FULL_NAME'
    /** Hair color. */
    | 'HAIR_COLOR'
    /** HazMat endorsement expiry date. */
    | 'HAZ_MAT_ENDORSEMENT_EXPIRY_DATE'
    /** Height in CM. */
    | 'HEIGHT_IN_CM'
    /** Height in feet/inches. */
    | 'HEIGHT_IN_FEET_INCHES'
    /** Inventory control number. */
    | 'INVENTORY_CONTROL_NUMBER'
    /** Issue timestamp. */
    | 'ISSUE_TIMESTAMP'
    /** Jurisdiction-specific. */
    | 'JURISDICTION_SPECIFIC'
    /** Jurisdiction-specific restriction code description. */
    | 'JURISDICTION_SPECIFIC_RESTRICTION_CODE_DESCRIPTION'
    /** Jurisdiction-specific vehicle classification description. */
    | 'JURISDICTION_SPECIFIC_VEHICLE_CLASSIFICATION_DESCRIPTION'
    /** Last name. */
    | 'LAST_NAME'
    /** License classification code. */
    | 'LICENSE_CLASSIFICATION_CODE'
    /** License endorsements code. */
    | 'LICENSE_ENDORSEMENT_CODE'
    /** License expiration date. */
    | 'LICENSE_EXPIRATION_DATE'
    /** License or ID document issue date. */
    | 'LICENSE_OR_ID_DOCUMENT_ISSUE_DATE'
    /** License or ID number. */
    | 'LICENSE_OR_ID_NUMBER'
    /** License restriction code. */
    | 'LICENSE_RESTRICTION_CODE'
    /** Limited duration document indicator. */
    | 'LIMITED_DURATION_DOCUMENT_INDICATOR'
    /** Mailing city. */
    | 'MAILING_CITY'
    /** Mailing jurisdiction code. */
    | 'MAILING_JURISDICTION_CODE'
    /** Mailing postal code. */
    | 'MAILING_POSTAL_CODE'
    /** Mailing street address line 1. */
    | 'MAILING_STREET_ADDRESS_1'
    /** Mailing street address line 2. */
    | 'MAILING_STREET_ADDRESS_2'
    /** Medical indicator codes. */
    | 'MEDICAL_INDICATOR_CODES'
    /** MIddle name or initial. */
    | 'MIDDLE_NAME_OR_INITIAL'
    /** Middle names truncation. */
    | 'MIDDLE_NAMES_TRUNCATION'
    /** Name prefix. */
    | 'NAME_PREFIX'
    /** Name suffix. */
    | 'NAME_SUFFIX'
    /** Non-resident indicator. */
    | 'NON_RESIDENT_INDICATOR'
    /** Number of duplicates. */
    | 'NUMBER_OF_DUPLICATES'
    /** Organ donor. */
    | 'ORGAN_DONOR'
    /** Organ donor indicator. */
    | 'ORGAN_DONOR_INDICATOR'
    /** Permit classification code. */
    | 'PERMIT_CLASSIFICATION_CODE'
    /** Permit endorsement code. */
    | 'PERMIT_ENDORSEMENT_CODE'
    /** Permit expiration date. */
    | 'PERMIT_EXPIRATION_DATE'
    /** Permit identifier. */
    | 'PERMIT_IDENTIFIER'
    /** Permit issue date. */
    | 'PERMIT_ISSUE_DATE'
    /** Permit restriction code. */
    | 'PERMIT_RESTRICTION_CODE'
    /** Weight range. */
    | 'PHYSICAL_DESCRIPTION_WEIGHT_RANGE'
    /** Place of birth. */
    | 'PLACE_OF_BIRTH'
    /** Prefix. */
    | 'PREFIX'
    /** Race or ethnicity. */
    | 'RACE_ETHNICITY'
    /** Residence city. */
    | 'RESIDENCE_CITY'
    /** Residence jurisdiction code. */
    | 'RESIDENCE_JURISDICTION_CODE'
    /** Residence postal code. */
    | 'RESIDENCE_POSTAL_CODE'
    /** Residence street address line 1. */
    | 'RESIDENCE_STREET_ADDRESS_1'
    /** Residence street address line 2. */
    | 'RESIDENCE_STREET_ADDRESS_2'
    /** Sex. */
    | 'SEX'
    /** Social security number. */
    | 'SOCIAL_SECURITY_NUMBER'
    /** Standard endorsement code. */
    | 'STANDARD_ENDORSEMENT_CODE'
    /** Standard restriction code. */
    | 'STANDARD_RESTRICTION_CODE'
    /** Standard vehicle classification. */
    | 'STANDARD_VEHICLE_CLASSIFICATION'
    /** Suffix. */
    | 'SUFFIX'
    /** Under 18 until. */
    | 'UNDER_18_UNTIL'
    /** Under 19 until. */
    | 'UNDER_19_UNTIL'
    /** Under 21 until. */
    | 'UNDER_21_UNTIL'
    /** Unique customer identifier. */
    | 'UNIQUE_CUSTOMER_IDENTIFIER'
    /** Veteran indicator. */
    | 'VETERAN_INDICATOR'
    /** Virginia-specific class. */
    | 'VIRGINIA_SPECIFIC_CLASS'
    /** Virginia-specific endorsements. */
    | 'VIRGINIA_SPECIFIC_ENDORSEMENTS'
    /** Virginia-specific restrictions. */
    | 'VIRGINIA_SPECIFIC_RESTRICTIONS'
    /** Weight in KG. */
    | 'WEIGHT_IN_KG'
    /** Weight in LBS. */
    | 'WEIGHT_IN_LBS'
    /** Unknown. */
    | 'UNKNOWN';

/** Boarding Pass Document Format */
export interface BoardingPassDocumentFormat extends BaseDocumentFormat {
    /** Number of legs */
    numberOfLegs: number;

    /** True if electronic ticket, false otherwise */
    electronicTicket: boolean;

    /** Security Data */
    securityData: string;

    /** Legs */
    legs?: BoardingPassLeg[];
}

/** Boarding Pass Leg */
export interface BoardingPassLeg {
    /** Boarding Pass Leg Fields */
    fields: BoardingPassLegField[];
}

/** Boarding Pass Leg Field */
export interface BoardingPassLegField {
    /** Boarding Pass Document Field Type */
    type: BoardingPassDocumentFieldType;

    /** Boarding Pass Document Field Value */
    value: string;
}

/** Boarding Pass Document Field Type */
export type BoardingPassDocumentFieldType =
    /** Airline designator of boarding pass issuer. */
    | 'AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER'
    /** Airline numeric code. */
    | 'AIRLINE_NUMERIC_CODE'
    /** Baggage tag license plate numbers. */
    | 'BAGGAGE_TAG_LICENSE_PLATE_NUMBERS'
    /** Check-in sequence number. */
    | 'CHECK_IN_SEQUENCE_NUMBER'
    /** Compartment code. */
    | 'COMPARTMENT_CODE'
    /** Date of boarding pass issuance in Julian format. */
    | 'DATE_OF_BOARDING_PASS_ISSUANCE_JULIAN'
    /** Date of flight in Julian format. */
    | 'DATE_OF_FLIGHT_JULIAN'
    /** Departure airport code. */
    | 'DEPARTURE_AIRPORT_CODE'
    /** Destination airport code. */
    | 'DESTINATION_AIRPORT_CODE'
    /** Document form serial number. */
    | 'DOCUMENT_FORM_SERIAL_NUMBER'
    /** Document type. */
    | 'DOCUMENT_TYPE'
    /** Fast track. */
    | 'FAST_TRACK'
    /** First non-consecutive baggage tag license plate number. */
    | 'FIRST_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER'
    /** Flight number. */
    | 'FLIGHT_NUMBER'
    /** For individual airline use. */
    | 'FOR_INDIVIDUAL_AIRLINE_USE'
    /** Free baggage allowance. */
    | 'FREE_BAGGAGE_ALLOWANCE'
    /** Frequent flyer airline designator. */
    | 'FREQUENT_FLYER_AIRLINE_DESIGNATOR'
    /** Frequent flyer number. */
    | 'FREQUENT_FLYER_NUMBER'
    /** IDAD indicator. */
    | 'IDAD_INDICATOR'
    /** International document verification. */
    | 'INTERNATIONAL_DOCUMENTATION_VERIFICATION'
    /** Marketing carrier designator. */
    | 'MARKETING_CARRIER_DESIGNATOR'
    /** Operating carrier designator. */
    | 'OPERATING_CARRIER_DESIGNATOR'
    /** Operating carrier PNR code. */
    | 'OPERATING_CARRIER_PNR_CODE'
    /** Passenger description. */
    | 'PASSENGER_DESCRIPTION'
    /** Passenger status. */
    | 'PASSENGER_STATUS'
    /** Seat number. */
    | 'SEAT_NUMBER'
    /** Second non-consecutive baggage tag license plate number. */
    | 'SECOND_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER'
    /** Selectee indicator. */
    | 'SELECTEE_INDICATOR'
    /** Source of boarding pass issuance. */
    | 'SOURCE_OF_BOARDING_PASS_ISSUANCE'
    /** Source of check-in. */
    | 'SOURCE_OF_CHECK_IN'
    /** Version number. */
    | 'VERSION_NUMBER'
    /** Unknown */
    | 'UNKNOWN';

/** GS1 Document Format */
export interface GS1DocumentFormat extends BaseDocumentFormat {
    /** GS1 Document fields */
    fields: GS1DocumentField[];
}

/** GS1 Document Field */
export interface GS1DocumentField {
    /** Field raw value */
    rawValue: string;

    /** Application Identifier */
    applicationIdentifier: string;

    /** Data Title */
    dataTitle: string;

    /** Field description */
    fieldDescription: string;

    /** True if it is standard, false otherwise */
    standard: boolean;

    /** Validation Status */
    validationStatus: GS1SystemElementValidationStatus;
}

/** GS1 Element Validation Status */
export type GS1SystemElementValidationStatus =
    /** The GS1 Field is valid */
    | 'VALID'
    /** The GS1 Field is not valid */
    | 'INVALID';

/** ID Card PDF417 Document Format */
export interface IDCardPDF417DocumentFormat extends BaseDocumentFormat {
    /** ID Card PDF417 Document Fields */
    fields: IDCardPDF417DocumentField[];
}

/** ID Card PDF417 Document Field */
export interface IDCardPDF417DocumentField {
    /** Field Type */
    type?: IDCardPDF417DocumentFieldType;

    /** Field Value */
    value: string;
}

/** ID Card PDF417 Document Field Type */
export type IDCardPDF417DocumentFieldType =
    /** First Name */
    | 'FIRST_NAME'
    /** Last Name */
    | 'LAST_NAME'
    /** Document Code */
    | 'DOCUMENT_CODE'
    /** Birth Date */
    | 'BIRTH_DATE'
    /** Date Issued */
    | 'DATE_ISSUED'
    /** Date Expired */
    | 'DATE_EXPIRED'
    /** Optional 1 */
    | 'OPTIONAL_1'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Certificate Document Format */
export interface MedicalCertificateDocumentFormat extends BaseDocumentFormat {
    /** Medical Certificate Document Fields */
    fields: MedicalCertificateDocumentField[];
}

/** Medical Certificate Document Field */
export interface MedicalCertificateDocumentField {
    /** Medical Certificate Document Field Type */
    type?: MedicalCertificateDocumentFieldType;

    /** Medical Certificate Document Field Value */
    value: string;
}

/** Medical Certificate Document Field Type */
export type MedicalCertificateDocumentFieldType =
    /** Requires Care */
    | 'REQUIRES_CARE'
    /** Accident */
    | 'ACCIDENT'
    /** Initial Certificate */
    | 'INITIAL_CERTIFICATE'
    /** Renewed Certificate */
    | 'RENEWED_CERTIFICATE'
    /** Work Accident */
    | 'WORK_ACCIDENT'
    /** Assigned To Accident Insurance Doctor */
    | 'ASSIGNED_TO_ACCIDENT_INSURANCE_DOCTOR'
    /** Incapable Of Work Since */
    | 'INCAPABLE_OF_WORK_SINCE'
    /** Incapable Of Work Until */
    | 'INCAPABLE_OF_WORK_UNTIL'
    /** Diagnosed On */
    | 'DIAGNOSED_ON'
    /** Document Date */
    | 'DOCUMENT_DATE'
    /** Birth Date */
    | 'BIRTH_DATE'
    /** First Name */
    | 'FIRST_NAME'
    /** Last Name */
    | 'LAST_NAME'
    /** Diagnose */
    | 'DIAGNOSE'
    /** Health Insurance Number */
    | 'HEALTH_INSURANCE_NUMBER'
    /** Insured Person Number */
    | 'INSURED_PERSON_NUMBER'
    /** Status */
    | 'STATUS'
    /** Place Of Operation Number */
    | 'PLACE_OF_OPERATION_NUMBER'
    /** Doctor Number */
    | 'DOCTOR_NUMBER'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Plan Document Format */
export interface MedicalPlanDocumentFormat extends BaseDocumentFormat {
    /** Identifier */
    GUID: string;

    /** Current page (index) */
    currentPage: number;

    /** Total number of pages */
    totalNumberOfPages: number;

    /** Document version number */
    documentVersionNumber: string;

    /** Patch version number */
    patchVersionNumber: string;

    /** Language country code */
    languageCountryCode: string;

    /** Patient Information */
    patient: MedicalPlanPatientInformation;

    /** Doctor Information */
    doctor: MedicalPlanDoctorInformation;

    /** Subheadings */
    subheadings: MedicalPlanStandardSubheading[];
}

/** Medical Plan Patient Information */
export interface MedicalPlanPatientInformation {
    /** Medical Plan Patient Fields */
    fields: MedicalPlanPatientField[];
}

/** Medical Plan Patient Field */
export interface MedicalPlanPatientField {
    /** Medical Plan Patient Field Type */
    type: MedicalPlanPatientFieldType;

    /** Medical Plan Patient Field Value */
    value: string;
}

/** Medical Plan Patient Field Type */
export type MedicalPlanPatientFieldType =
    /** First Name */
    | 'FIRST_NAME'
    /** Last Name */
    | 'LAST_NAME'
    /** Title */
    | 'TITLE'
    /** Pre Name */
    | 'PRE_NAME'
    /** Suffix */
    | 'SUFFIX'
    /** Patient Id */
    | 'PATIENT_ID'
    /** Birth Date */
    | 'BIRTH_DATE'
    /** Gender */
    | 'GENDER'
    /** Weight */
    | 'WEIGHT'
    /** Height */
    | 'HEIGHT'
    /** Creatinine Value */
    | 'CREATININE_VALUE'
    /** Allergies And Intolerances */
    | 'ALLERGIES_AND_INTOLERANCES'
    /** Breast Feeding */
    | 'BREAST_FEEDING'
    /** Pregnant */
    | 'PREGNANT'
    /** Patient Free Text */
    | 'PATIENT_FREE_TEXT'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Plan Doctor Information */
export interface MedicalPlanDoctorInformation {
    /** Medical Plan Doctor Information Fields */
    fields: MedicalPlanDoctorField[];
}

/** Medical Plan Doctor Field */
export interface MedicalPlanDoctorField {
    /** Medical Plan Doctor Field Type */
    type: MedicalPlanDoctorFieldType;

    /** Medical Plan Doctor Field Value */
    value: string;
}

/** Medical Plan Doctor Field Type */
export type MedicalPlanDoctorFieldType =
    /** Issuer name */
    | 'ISSUER_NAME'
    /** Doctor number */
    | 'DOCTOR_NUMBER'
    /** Pharmacy ID */
    | 'PHARMACY_ID'
    /** Hospital ID */
    | 'HOSPITAL_ID'
    /** Street */
    | 'STREET'
    /** Postal Code */
    | 'POSTAL_CODE'
    /** Place */
    | 'PLACE'
    /** Telephone Number */
    | 'TELEPHONE_NUMBER'
    /** Email */
    | 'EMAIL'
    /** Issuing date and time */
    | 'ISSUING_DATE_AND_TIME'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Plan Standard Subheading */
export interface MedicalPlanStandardSubheading {
    /** Subheading Fields */
    fields: MedicalPlanStandardSubheadingField[];

    /** General Notes */
    generalNotes: string[];

    /** Medicines */
    medicines: MedicalPlanMedicine[];

    /** Prescriptions */
    prescriptions: MedicalPlanPrescription[];
}

/** Medical Plan Standard Subheading Field */
export interface MedicalPlanStandardSubheadingField {
    /** Medical Plan Standard Subheading Field Type */
    type: MedicalPlanStandardSubheadingFieldType;

    /** Medical Plan Standard Subheading Field Value */
    value: string;
}

/** Medical Plan Standard Subheading Field Type */
export type MedicalPlanStandardSubheadingFieldType =
    /** Key words */
    | 'KEY_WORDS'
    /** Subheading free text */
    | 'SUBHEADING_FREE_TEXT';

/** Medical Plan Medicine */
export interface MedicalPlanMedicine {
    /** Medical Plan Medicine Fields */
    fields: MedicalPlanMedicineField[];

    /** Medical Plan Medicine Substances */
    substances: MedicalPlanMedicineSubstance[];
}

/** Medical Plan Medicine Field */
export interface MedicalPlanMedicineField {
    /** Medical Plan Medicine Field Type */
    type: MedicalPlanMedicineFieldType;

    /** Medical Plan Medicine Field Value */
    value: string;
}

/** Medical Plan Medicine Field Type */
export type MedicalPlanMedicineFieldType =
    /** Pharmaceutical number */
    | 'PHARMACEUTICAL_NUMBER'
    /** Drug name */
    | 'DRUG_NAME'
    /** Dosage form */
    | 'DOSAGE_FORM'
    /** Dosage form free text */
    | 'DOSAGE_FORM_FREE_TEXT'
    /** Morning */
    | 'MORNING'
    /** Midday */
    | 'MIDDAY'
    /** Evening */
    | 'EVENING'
    /** Night */
    | 'NIGHT'
    /** Dosage free text */
    | 'DOSAGE_FREE_TEXT'
    /** Dosing unit */
    | 'DOSING_UNIT'
    /** Dosing unit free text */
    | 'DOSING_UNIT_FREE_TEXT'
    /** Relevant info */
    | 'RELEVANT_INFO'
    /** Reason for treatment */
    | 'REASON_FOR_TREATMENT'
    /** General notes */
    | 'GENERAL_NOTES'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Plan Medicine Substance */
export interface MedicalPlanMedicineSubstance {
    /** Medical Plan Medicine Substance Fields */
    fields: MedicalPlanMedicineSubstanceField[];
}

/** Medical Plan Medicine Substance Field */
export interface MedicalPlanMedicineSubstanceField {
    /** Medical Plan Medicine Substance Field Type */
    type: MedicalPlanMedicineSubstanceFieldType;

    /** Medical Plan Medicine Substance Field Value */
    value: string;
}

/** Medical Plan Medicine Substance Field Type */
export type MedicalPlanMedicineSubstanceFieldType =
    /** Active substance */
    | 'ACTIVE_SUBSTANCE'
    /** Potency */
    | 'POTENCY'
    /** Unknown */
    | 'UNKNOWN';

/** Medical Plan Prescription */
export interface MedicalPlanPrescription {
    /** Medical Plan Prescription Fields */
    fields: MedicalPlanPrescriptionField[];
}

/** Medical Plan Prescription Field */
export interface MedicalPlanPrescriptionField {
    /** Medical Plan Prescription Field Type */
    type?: MedicalPlanPrescriptionFieldType;

    /** Medical Plan Prescription Field Value */
    value: string;
}

/** Medical Plan Prescription Field Type */
export type MedicalPlanPrescriptionFieldType =
    /** General informationm */
    | 'GENERAL_INFORMATION'
    /** Prescription free text */
    | 'PRESCRIPTION_FREE_TEXT'
    /** Unknown */
    | 'UNKNOWN';

/** SEPA Document Format */
export interface SEPADocumentFormat extends BaseDocumentFormat {
    /** SEPA Document Format Fields */
    fields: SEPADocumentFormatField[];
}

/** SEPA Document Format Field */
export interface SEPADocumentFormatField {
    /** SEPA Document Field Type */
    type: SEPADocumentFieldType;

    /** SEPA Document Field Value */
    value: string;
}

/** SEPA Document Field Type */
export type SEPADocumentFieldType =
    /** Service tag */
    | 'SERVICE_TAG'
    /** Version */
    | 'VERSION'
    /** Character set */
    | 'CHARACTER_SET'
    /** Identification */
    | 'IDENTIFICATION'
    /** Receiver IBAN */
    | 'RECEIVER_IBAN'
    /** Receiver BIC */
    | 'RECEIVER_BIC'
    /** Receiver name */
    | 'RECEIVER_NAME'
    /** Receiver amount */
    | 'AMOUNT'
    /** Purpose */
    | 'PURPOSE'
    /** Remittance */
    | 'REMITTANCE'
    /** Information */
    | 'INFORMATION'
    /** Unknown */
    | 'UNKNOWN';

/** Swiss QR Code Document Format */
export interface SwissQRCodeDocumentFormat extends BaseDocumentFormat {
    /** Swiss QR Code Document Fields */
    fields: SwissQRCodeDocumentField[];

    /** Swiss QR Code Version */
    version: SwissQRCodeVersion;
}

/** Swiss QR Code Document Field */
export interface SwissQRCodeDocumentField {
    /** Swiss QR Code Document Field Type */
    type: SwissQRCodeDocumentFieldType;

    /** Swiss QR Code Document Field Value */
    value: string;

    /** Swiss QR Code Document Field Human-readable String */
    typeHumanReadableString: string;
}

/** Swiss QR Code Document Field Type */
export type SwissQRCodeDocumentFieldType =
    /** Additional Billing Information */
    | 'ADDITIONAL_BILLING_INFORMATION'
    /** Additional Info Trailer */
    | 'ADDITIONAL_INFO_TRAILER'
    /** Additional Info Unstructured */
    | 'ADDITIONAL_INFO_UNSTRUCTURED'
    /** Alternative Procedure Parameter */
    | 'ALTERNATIVE_PROCEDURE_PARAMETER'
    /** Amount */
    | 'AMOUNT'
    /** Currency */
    | 'CURRENCY'
    /** Debtor Address Type */
    | 'DEBTOR_ADDRESS_TYPE'
    /** Debtor Country */
    | 'DEBTOR_COUNTRY'
    /** Debtor Name */
    | 'DEBTOR_NAME'
    /** Debtor Place */
    | 'DEBTOR_PLACE'
    /** Debtor Postal Code */
    | 'DEBTOR_POSTAL_CODE'
    /** Debtor Street Or Address Line 1 */
    | 'DEBTOR_STREET_OR_ADDRESS_LINE_1'
    /** Debtor Street Or Address Line 2 */
    | 'DEBTOR_STREET_OR_ADDRESS_LINE_2'
    /** Due Date */
    | 'DUE_DATE'
    /** Encoding */
    | 'ENCODING'
    /** Final Payee Address Type */
    | 'FINAL_PAYEE_ADDRESS_TYPE'
    /** Final Payee Building Or Address Line 2 */
    | 'FINAL_PAYEE_BUILDING_OR_ADDRESS_LINE_2'
    /** Final Payee Country */
    | 'FINAL_PAYEE_COUNTRY'
    /** Final Payee Name */
    | 'FINAL_PAYEE_NAME'
    /** Final Payee Place */
    | 'FINAL_PAYEE_PLACE'
    /** Final Payee Postal Code */
    | 'FINAL_PAYEE_POSTAL_CODE'
    /** Final Payee Street Or Address Line 1 */
    | 'FINAL_PAYEE_STREET_OR_ADDRESS_LINE_1'
    /** Iban */
    | 'IBAN'
    /** Payee Address Type */
    | 'PAYEE_ADDRESS_TYPE'
    /** Payee Building Or Address Line 2 */
    | 'PAYEE_BUILDING_OR_ADDRESS_LINE_2'
    /** Payee Country */
    | 'PAYEE_COUNTRY'
    /** Payee Name */
    | 'PAYEE_NAME'
    /** Payee Place */
    | 'PAYEE_PLACE'
    /** Payee Postal Code */
    | 'PAYEE_POSTAL_CODE'
    /** Payee Street Or Address Line 1 */
    | 'PAYEE_STREET_OR_ADDRESS_LINE_1'
    /** Payment Reference */
    | 'PAYMENT_REFERENCE'
    /** Payment Reference Type */
    | 'PAYMENT_REFERENCE_TYPE'
    /** Unknown */
    | 'UNKNOWN';

/** Swiss QR Code Version */
export type SwissQRCodeVersion =
    /** Version 1.0 */
    | 'V1_0'
    /** Version 2.0 */
    | 'V2_0'
    /** Version 2.1 */
    | 'V2_1'
    /** Unknown */
    | 'UNKNOWN';

/** vCard Document Format */
export interface VCardDocumentFormat extends BaseDocumentFormat {
    /** vCard Document Format Fields */
    fields: VCardDocumentFormatField[];
}

/** vCard Document Field */
export interface VCardDocumentFormatField {
    /** vCard Document Field Type */
    type: VCardDocumentFormatFieldType;

    /** vCard Document Field Type Modifiers */
    typeModifiers: string[];

    /** vCard Document Field Raw Text */
    rawText?: string;

    /** vCard Document Field Values */
    values: string[];
}

/** vCard Document Field Type */
export type VCardDocumentFormatFieldType =
    /** Anniversary */
    | 'ANNIVERSARY'
    /** Birthday */
    | 'BIRTHDAY'
    /** Busy Time Url */
    | 'BUSY_TIME_URL'
    /** Calendar Uri */
    | 'CALENDAR_URI'
    /** Calendar Uri For Requests */
    | 'CALENDAR_URI_FOR_REQUESTS'
    /** Categories */
    | 'CATEGORIES'
    /** Client Pid Map */
    | 'CLIENT_PID_MAP'
    /** Custom */
    | 'CUSTOM'
    /** Delivery Address */
    | 'DELIVERY_ADDRESS'
    /** Email */
    | 'EMAIL'
    /** First Name */
    | 'FIRST_NAME'
    /** Gender */
    | 'GENDER'
    /** Geo Location */
    | 'GEO_LOCATION'
    /** Impp */
    | 'IMPP'
    /** Kind */
    | 'KIND'
    /** Languages */
    | 'LANGUAGES'
    /** Logo */
    | 'LOGO'
    /** Member */
    | 'MEMBER'
    /** Name */
    | 'NAME'
    /** Nickname */
    | 'NICKNAME'
    /** Note */
    | 'NOTE'
    /** Organisation */
    | 'ORGANISATION'
    /** Photo */
    | 'PHOTO'
    /** Product ID */
    | 'PRODUCT_ID'
    /** Public Key */
    | 'PUBLIC_KEY'
    /** Related */
    | 'RELATED'
    /** Revision */
    | 'REVISION'
    /** Role */
    | 'ROLE'
    /** Sound */
    | 'SOUND'
    /** Source */
    | 'SOURCE'
    /** Telephone Number */
    | 'TELEPHONE_NUMBER'
    /** Time Zone */
    | 'TIME_ZONE'
    /** Title */
    | 'TITLE'
    /** UID */
    | 'UID'
    /** URL */
    | 'URL'
    /** Version */
    | 'VERSION'
    /** Xml */
    | 'XML'
    /** Unknown */
    | 'UNKNOWN';

/** The SDK license status */
export type LicenseStatus =
    /** License is valid and accepted. */
    | 'Okay'
    /** No license set yet. The SDK is in trial mode. */
    | 'Trial'
    /** No license set yet. The SDKs trial mode is over. */
    | 'Expired'
    /** No license active. The set license does not cover the current operating system. */
    | 'WrongOS'
    /** No license active. The set license was unreadable or has an invalid format. */
    | 'Corrupted'
    /** No license active. The set licenses does not cover the current apps bundle identifier. */
    | 'AppIDMismatch'
    /** No license set yet. The SDKs trial mode is over. */
    | 'NotSet';

/** Barcode document format */
export type BarcodeDocumentFormat =
    /** American Association of Motor Vehicle Administrators barcode document */
    | 'AAMVA'
    /** Boarding pass barcode document */
    | 'BOARDING_PASS'
    /** German medical plan barcode document */
    | 'DE_MEDICAL_PLAN'
    /** German medical certificate barcode document */
    | 'MEDICAL_CERTIFICATE'
    /** ID Card barcode document */
    | 'ID_CARD_PDF_417'
    /** SEPA barcode document */
    | 'SEPA'
    /** Swiss QR barcode document */
    | 'SWISS_QR'
    /** VCard barcode document */
    | 'VCARD'
    /** GS1 barcode document */
    | 'GS1';

/** Barcode document format */
export type BarcodeFormat =
    /** Aztec barcode type */
    | 'AZTEC'
    /** CODABAR barcode type */
    | 'CODABAR'
    /** CODE_25 barcode type */
    | 'CODE_25'
    /** CODE_39 barcode type */
    | 'CODE_39'
    /** CODE_93 barcode type */
    | 'CODE_93'
    /** CODE_128 barcode type */
    | 'CODE_128'
    /** DATA_MATRIX barcode type */
    | 'DATA_MATRIX'
    /** EAN_8 barcode type */
    | 'EAN_8'
    /** EAN_13 barcode type */
    | 'EAN_13'
    /** ITF barcode type */
    | 'ITF'
    /** PDF_417 barcode type */
    | 'PDF_417'
    /** QR_CODE barcode type */
    | 'QR_CODE'
    /** MICRO_QR_CODE barcode type */
    | 'MICRO_QR_CODE'
    /** RSS_14 barcode type */
    | 'RSS_14'
    /** RSS_EXPANDED barcode type */
    | 'RSS_EXPANDED'
    /** UPC_A barcode type */
    | 'UPC_A'
    /** UPC_E barcode type */
    | 'UPC_E'
    /** MSI Plessey barcode type */
    | 'MSI_PLESSEY'
    /** IATA (2 of 5) barcode type */
    | 'IATA_2_OF_5'
    /** INDUSTRIAL (2 of 5) barcode type */
    | 'INDUSTRIAL_2_OF_5'
    /** USPS Intelligent Mail, a.k.a. USPS OneCode, USPS-STD-11 */
    | 'USPS_INTELLIGENT_MAIL'
    /** Royal Mail Four-State Customer Code, a.k.a. RM4SCC, CBC, BPO 4 State Code */
    | 'ROYAL_MAIL'
    /** Japan Post Four-State Barcode */
    | 'JAPAN_POST'
    /** Royal TNT Post Four-State Barcode, a.k.a. KIX, Klant IndeX */
    | 'ROYAL_TNT_POST'
    /** Australia Post Four-State Customer Code */
    | 'AUSTRALIA_POST'
    /** GS1 DataBar Limited */
    | 'DATABAR_LIMITED'
    /** GS1 DataBar Composite */
    | 'GS1_COMPOSITE';

/** A filter for extended EAN and UPC barcodes. */
export type BarcodesExtensionFilter =
    /** EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not. */
    | 'NO_FILTER'
    /** Only EAN and UPC codes with extensions are returned. */
    | 'ONLY_WITH_EXTENSIONS'
    /** Only EAN and UPC codes without extensions are returned. */
    | 'ONLY_WITHOUT_EXTENSIONS';

/** Camera module to use */
export type CameraModule =
    /** Front camera */
    | 'FRONT'
    /** Back camera */
    | 'BACK'
    /** The back camera with the widest available lens. iOS only. */
    | 'BACK_WIDEST';

/** MSI plessey checksum algorithm */
export type MSIPlesseyChecksumAlgorithm =
    /** Not use checksum */
    | 'NONE'
    /** Mod10 checksum algorithm */
    | 'MOD_10'
    /** Mod11IBM checksum algorithm */
    | 'MOD_11_IBM'
    /** Mod11NCR checksum algorithm */
    | 'MOD_11_NCR'
    /** Mod1010 checksum algorithm */
    | 'MOD_1010'
    /** Mod1110IBM checksum algorithm */
    | 'MOD_1110_IBM'
    /** Mod1110NCR checksum algorithm */
    | 'MOD_1110_NCR';

/** Barcode scanner engine mode */
export type EngineMode =
    /** Recommended barcode scanning mode. Used by default */
    | 'NEXT_GEN'
    /** Legacy barcode scanning mode. */
    | 'LEGACY';

/** Applied interface orientation */
export type OrientationLockMode =
    /** Do not restrict interface orientation */
    | 'NONE'
    /** Portrait screen orientations only */
    | 'PORTRAIT'
    /** Landscape screen orientations only */
    | 'LANDSCAPE';

/** Finder aspect ratio */
export interface AspectRatio {
    /** The width component of the aspect ratio. */
    width: number;

    /** The height component of the aspect ratio. */
    height: number;
}

/** Standard size object */
export interface Size {
    /** Width parameter */
    width: number;

    /** Height parameter */
    height: number;
}

/** The expected density of QR codes in an image. */
export type CodeDensity =
    /** Up to 6 QR codes per image. */
    | 'LOW'
    /** Up to 24 QR codes per image. */
    | 'HIGH';

/** Represents camera preview modes */
export type CameraPreviewMode =
    /** In this mode camera preview frames will be downscaled to the layout view size - full preview frame content will be visible, but unused edges could be appeared in the preview layout. */
    | 'FIT_IN'
    /** In this mode camera preview frames fill the layout view - the preview frames may contain additional content on the edges that was not visible in the preview layout. */
    | 'FILL_IN';

/** Barcode scanner engine mode */
export type BarcodeOverlayTextFormat =
    /** Show only barcode overlay frame. */
    | 'NONE'
    /** Show barcode value with extention. */
    | 'CODE'
    /** Show barcode value with barcode format. */
    | 'CODE_AND_TYPE';

/** GS1 handling mode */
export type Gs1HandlingMode =
    /** No special handling for GS1-formatted results. Special (FNC1) characters are stripped. Equivalent to assumeGS1=false in ZXing for Code128 results. */
    | 'NONE'
    /** GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D). Message is not validated. This is the default. The implied 01 AI key is prepended to DataBar results. Equivalent to assumeGS1=true in ZXing for Code128 results. */
    | 'PARSE'
    /** GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D) and validated. The implied 01 AI key is prepended to DataBar results. Invalid messages are not returned. */
    | 'VALIDATE'
    /** GS1 strings are converted to human-readable format and validated. The implied (01) AI key is prepended to DataBar results. Invalid messages are not returned. */
    | 'DECODE';

/** Barcode Selection Overlay configuration */
export interface SelectionOverlayConfiguration {
    /** Whether the barcode selection overlay is enabled or not. */
    overlayEnabled: boolean;

    /** Whether the barcode is selected automatically when being detected or not. */
    automaticSelectionEnabled: boolean;

    /** Define the way of how to show barcode data with selection overlay. */
    textFormat: BarcodeOverlayTextFormat;

    /** The color of the polygon in the selection overlay. */
    polygonColor: string;

    /** The color of the text in the selection overlay. */
    textColor: string;

    /** The color of the texts background in the selection overlay. */
    textContainerColor: string;

    /** The color of the polygon in the selection overlay, when highlighted. */
    highlightedPolygonColor: string;

    /** The color of the text in the selection overlay, when highlighted. */
    highlightedTextColor: string;

    /** The color of the texts background in the selection overlay, when highlighted. */
    highlightedTextContainerColor: string;
}

/** Confirmation Dialog configuration */
export interface ConfirmationDialogConfiguration {
    /** Defines, if the confirmation dialog should be displayed or not before returing the results to the delegate. Defaults to False. */
    resultWithConfirmationEnabled: boolean;

    /** The text format of the result dialog. Defaults to TYPE_AND_CODE. */
    dialogTextFormat: BarcodeDialogFormat;

    /** The style of the confirmation dialog. iOS only. */
    confirmationDialogStyle: DialogStyle;

    /** The title of the confirmation dialog confirm button. */
    confirmButtonTitle: string;

    /** The style of the confirmation dialogs confirm button. iOS only. */
    confirmationDialogConfirmButtonStyle: DialogButtonStyle;

    /** The title of the confirmation dialog retry button. */
    retryButtonTitle: string;

    /** The style of the confirmation dialogs retry button. iOS only. */
    confirmationDialogRetryButtonStyle: DialogButtonStyle;

    /** The title of the confirmation dialog. */
    dialogTitle: string;

    /** The message text of the confirmation dialog. */
    dialogMessage: string;

    /** The accent color of buttons on a confirmation dialog. Android only. */
    dialogButtonsAccentColor: string;

    /** Allows to set if the confirm button should be filled. Defaults to TRUE. Android only. */
    confirmButtonFilled: boolean;

    /** Allows to set a text color of the filled button. See `confirmationDialogConfirmButtonFilled`. Android only. */
    confirmButtonFilledTextColor: string;
}

/** The font name and size. iOS only. */
export interface Font {
    /** The font name. defaults to SYSTEM. */
    fontName: string;

    /** The font size. defaults 17.0 . */
    fontSize: number;
}

/** The blur effect style. iOS only. */
export type BlurEffect =
    /** The area of the view is lighter than the underlying view. */
    | 'EXTRA_LIGHT'
    /** The area of the view is the same approximate lightness of the underlying view. */
    | 'LIGHT'
    /** The area of the view is darker than the underlying view. */
    | 'DARK'
    /** A regular blur style that adapts to the user interface style. */
    | 'REGULAR'
    /** A blur style for making content more prominent that adapts to the user interface style. */
    | 'PROMINENT'
    /** An adaptable blur effect that creates the appearance of an ultra-thin material. iOS13+. */
    | 'SYSTEM_ULTRA_THIN_MATERIAL'
    /** An adaptable blur effect that creates the appearance of a thin material. iOS13+. */
    | 'SYSTEM_THIN_MATERIAL'
    /** An adaptable blur effect that create the appearance of a material with normal thickness. Defaults on iOS13 and more. iOS13+. */
    | 'SYSTEM_MATERIAL'
    /** An adaptable blur effect that creates the appearance of a material that's thicker than normal. iOS13+. */
    | 'SYSTEM_THICK_MATERIAL'
    /** An adaptable blur effect that creates the appearance of the system chrome. iOS13+. */
    | 'SYSTEM_CHROME_MATERIAL'
    /** A blur effect that creates the appearance of an ultra-thin material and is always light. iOS13+. */
    | 'SYSTEM_ULTRA_THIN_MATERIAL_LIGHT'
    /** A blur effect that creates the appearance of a thin material and is always light. iOS13+. */
    | 'SYSTEM_THIN_MATERIAL_LIGHT'
    /** A blur effect that creates the appearance of a material with normal thickness and is always light. iOS13+. */
    | 'SYSTEM_MATERIAL_LIGHT'
    /** A blur effect that creates the appearance of a material that’s thicker than normal and is always light. iOS13+. */
    | 'SYSTEM_THICK_MATERIAL_LIGHT'
    /** A blur effect that creates the appearance of the system chrome and is always light. iOS13+ */
    | 'SYSTEM_CHROME_MATERIAL_LIGHT'
    /** A blur effect that creates the appearance of an ultra-thin material and is always dark. iOS13+ */
    | 'SYSTEM_ULTRA_THIN_MATERIAL_DARK'
    /** A blur effect that creates the appearance of a thin material and is always dark. iOS13+ */
    | 'SYSTEM_THIN_MATERIAL_DARK'
    /** A blur effect that creates the appearance of a material with normal thickness and is always dark. iOS13+. */
    | 'SYSTEM_MATERIAL_DARK'
    /** A blur effect that creates the appearance of a material that’s thicker than normal and is always dark. iOS13+. */
    | 'SYSTEM_THICK_MATERIAL_DARK'
    /** A blur effect that creates the appearance of the system chrome and is always dark. iOS13+ */
    | 'SYSTEM_CHROME_MATERIAL_DARK';

/** Defines a range for zooming */
export interface ZoomRange {
    /** The minimum zoom scale. Defaults to 1.0. */
    minZoom: number;

    /** The maximum zoom scale. Defaults to 12.0. */
    maxZoom: number;
}

/** Configuration for the dialog/alert style */
export interface DialogStyle {
    /** The Color of the screen-covering backdrop view. */
    screenBackgroundColor: string;

    /** The general background color of the actual dialog view. */
    dialogBackgroundColor: string;

    /** The visual effect of the dialogs background. */
    dialogBackgroundEffect: BlurEffect;

    /** The corner radius of the dialog. */
    cornerRadius: number;

    /** The color of the dialogs title. */
    titleColor: string;

    /** The font of the dialogs title */
    titleFont: Font;

    /** The color of the dialogs message. */
    messageColor: string;

    /** The font of the dialogs message. */
    messageFont: Font;

    /** The color of the separators around the dialogs button area. */
    separatorColor: string;

    /** The width of the separators in points. */
    separatorWidth: number;
}

/** Configuration for the dialogs/alerts OK button style. */
export interface DialogButtonStyle {
    /** The font of the button title. */
    font: Font;

    /** The color of the buttons title while not pressed. */
    textColor: string;

    /** The color of the buttons title while pressed. */
    highlightedTextColor: string;

    /** The background color of the button while not pressed. */
    backgroundColor: string;

    /** The background color of the button while pressed. */
    highlightedBackgroundColor: string;
}

/** The barcode text format dialog. */
export type BarcodeDialogFormat =
    /** Show the barcode value only. */
    | 'CODE'
    /** Show the barcode format with value. */
    | 'TYPE_AND_CODE';

/** Detect Barcodes On Images Result Field */
export interface DetectBarcodesOnImagesField {
    /** The URI of the image file the barcodes have been detected on */
    imageFileUri: string;

    /** The array of detected barcodes */
    barcodeResults: BarcodeResultField[];
}

/** File encryption mode, 'AES128' or 'AES256'. */
export type FileEncryptionMode =
    /** AES128 encryption mode */
    | 'AES128'
    /** AES256 encryption mode */
    | 'AES256';