scanbot-web-sdk 7.0.0-dev.1 → 7.0.0-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/@types/core/bridge/compiled/BarcodeDocumentModel.d.ts +1421 -0
  2. package/@types/core/bridge/compiled/CheckDocumentModel.d.ts +130 -0
  3. package/@types/core/bridge/compiled/CreditCardDocumentModel.d.ts +16 -0
  4. package/@types/core/bridge/compiled/DocumentsModel.d.ts +489 -0
  5. package/@types/core/bridge/compiled/TextPatternScannerTypes.d.ts +1 -21
  6. package/@types/core/bridge/compiled/VinScannerTypes.d.ts +79 -0
  7. package/@types/core/bridge/worker-bridge.d.ts +26 -12
  8. package/@types/core/worker/ScanbotSDK.Core.d.ts +8 -2
  9. package/@types/core-types.d.ts +5 -0
  10. package/@types/index.d.ts +1 -1
  11. package/@types/model/configuration/vin-scanner-configuration.d.ts +4 -4
  12. package/@types/scanbot-sdk.d.ts +14 -12
  13. package/@types/service/vin-scanner.d.ts +16 -0
  14. package/@types/text-pattern-scanner-view.d.ts +7 -7
  15. package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-image.d.ts +0 -1
  16. package/@types/ui2/scanbot-sdk-ui.d.ts +1 -1
  17. package/@types/utils/image-utils.d.ts +1 -0
  18. package/@types/worker/worker-bridge.d.ts +26 -12
  19. package/bundle/ScanbotSDK.min.js +5 -5
  20. package/bundle/ScanbotSDK.ui2.min.js +17 -17
  21. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  22. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  23. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  24. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  25. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  26. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  27. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  28. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  29. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  30. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  31. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  32. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  33. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  34. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  35. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  36. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  37. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  38. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  39. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  40. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  41. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  42. package/package.json +1 -1
@@ -0,0 +1,1421 @@
1
+ import { GenericDocument, Field } from './GenericDocument';
2
+ export type BarcodeDocumentModelRootType = typeof BoardingPassDocumentType | typeof SwissQRDocumentType | typeof DEMedicalPlanDocumentType | typeof IDCardPDF417DocumentType | typeof GS1DocumentType | typeof SEPADocumentType | typeof MedicalCertificateDocumentType | typeof VCardDocumentType | typeof AAMVADocumentType | typeof HIBCDocumentType;
3
+ export declare const BoardingPassDocumentType = "BoardingPass";
4
+ export declare const BoardingPassLegDocumentType = "Leg";
5
+ export declare const SwissQRDocumentType = "SwissQR";
6
+ export declare const DEMedicalPlanDocumentType = "DEMedicalPlan";
7
+ export declare const DEMedicalPlanPatientDocumentType = "Patient";
8
+ export declare const DEMedicalPlanDoctorDocumentType = "Doctor";
9
+ export declare const DEMedicalPlanSubheadingDocumentType = "Subheading";
10
+ export declare const DEMedicalPlanSubheadingMedicineDocumentType = "Medicine";
11
+ export declare const DEMedicalPlanSubheadingMedicineSubstanceDocumentType = "Substance";
12
+ export declare const DEMedicalPlanSubheadingPrescriptionDocumentType = "Prescription";
13
+ export declare const IDCardPDF417DocumentType = "IDCardPDF417";
14
+ export declare const GS1DocumentType = "GS1";
15
+ export declare const GS1ElementDocumentType = "Element";
16
+ export declare const GS1ElementValidationErrorDocumentType = "ValidationError";
17
+ export declare const SEPADocumentType = "SEPA";
18
+ export declare const MedicalCertificateDocumentType = "MedicalCertificate";
19
+ export declare const VCardDocumentType = "VCard";
20
+ export declare const VCardEntryDocumentType = "Entry";
21
+ export declare const VCardVersionDocumentType = "Version";
22
+ export declare const VCardSourceDocumentType = "Source";
23
+ export declare const VCardKindDocumentType = "Kind";
24
+ export declare const VCardXMLDocumentType = "XML";
25
+ export declare const VCardNameDocumentType = "Name";
26
+ export declare const VCardFirstNameDocumentType = "FirstName";
27
+ export declare const VCardNicknameDocumentType = "Nickname";
28
+ export declare const VCardBirthdayDocumentType = "Birthday";
29
+ export declare const VCardAnniversaryDocumentType = "Anniversary";
30
+ export declare const VCardGenderDocumentType = "Gender";
31
+ export declare const VCardDeliveryAddressDocumentType = "DeliveryAddress";
32
+ export declare const VCardPhotoDocumentType = "Photo";
33
+ export declare const VCardTelephoneNumberDocumentType = "TelephoneNumber";
34
+ export declare const VCardEmailDocumentType = "Email";
35
+ export declare const VCardIMPPDocumentType = "IMPP";
36
+ export declare const VCardLanguagesDocumentType = "Languages";
37
+ export declare const VCardTimeZoneDocumentType = "TimeZone";
38
+ export declare const VCardGeoLocationDocumentType = "GeoLocation";
39
+ export declare const VCardTitleDocumentType = "Title";
40
+ export declare const VCardRoleDocumentType = "Role";
41
+ export declare const VCardLogoDocumentType = "Logo";
42
+ export declare const VCardOrganisationDocumentType = "Organisation";
43
+ export declare const VCardMemberDocumentType = "Member";
44
+ export declare const VCardRelatedDocumentType = "Related";
45
+ export declare const VCardCategoriesDocumentType = "Categories";
46
+ export declare const VCardNoteDocumentType = "Note";
47
+ export declare const VCardProductIdDocumentType = "ProductId";
48
+ export declare const VCardRevisionDocumentType = "Revision";
49
+ export declare const VCardSoundDocumentType = "Sound";
50
+ export declare const VCardUIDDocumentType = "UID";
51
+ export declare const VCardClientPIDMapDocumentType = "ClientPIDMap";
52
+ export declare const VCardURLDocumentType = "URL";
53
+ export declare const VCardPublicKeyDocumentType = "PublicKey";
54
+ export declare const VCardBusyTimeURLDocumentType = "BusyTimeURL";
55
+ export declare const VCardCalendarURIForRequestsDocumentType = "CalendarURIForRequests";
56
+ export declare const VCardCalendarURIDocumentType = "CalendarURI";
57
+ export declare const VCardCustomDocumentType = "Custom";
58
+ export declare const AAMVADocumentType = "AAMVA";
59
+ export declare const AAMVATitleDataDocumentType = "TitleData";
60
+ export declare const AAMVARegistrationDataDocumentType = "RegistrationData";
61
+ export declare const AAMVAMotorCarrierDataDocumentType = "MotorCarrierData";
62
+ export declare const AAMVARegistrantAndVehicleDataDocumentType = "RegistrantAndVehicleData";
63
+ export declare const AAMVAVehicleOwnerDataDocumentType = "VehicleOwnerData";
64
+ export declare const AAMVAVehicleDataDocumentType = "VehicleData";
65
+ export declare const AAMVAVehicleSafetyInspectionDataDocumentType = "VehicleSafetyInspectionData";
66
+ export declare const AAMVADLIDDocumentType = "DLID";
67
+ export declare const AAMVADriverLicenseDocumentType = "DriverLicense";
68
+ export declare const AAMVAIDCardDocumentType = "IDCard";
69
+ export declare const AAMVAEnhancedDriverLicenseDocumentType = "EnhancedDriverLicense";
70
+ export declare const AAMVARawDocumentDocumentType = "RawDocument";
71
+ export declare const HIBCDocumentType = "HIBC";
72
+ /** Boarding Pass */
73
+ export declare class BoardingPass {
74
+ private _document;
75
+ get document(): GenericDocument;
76
+ constructor(document: GenericDocument);
77
+ requiredDocumentType(): string;
78
+ /** Electronic Ticket */
79
+ get electronicTicket(): Field;
80
+ /** Name */
81
+ get name(): Field;
82
+ /** Number Of Legs */
83
+ get numberOfLegs(): Field;
84
+ /** Security Data */
85
+ get securityData(): Field;
86
+ /** An array of all children of type "Leg". */
87
+ get legs(): BoardingPass.Leg[];
88
+ }
89
+ export declare namespace BoardingPass {
90
+ /** Leg of the journey */
91
+ class Leg {
92
+ private _document;
93
+ get document(): GenericDocument;
94
+ constructor(document: GenericDocument);
95
+ requiredDocumentType(): string;
96
+ /** Airline Designator Of Boarding Pass Issuer */
97
+ get airlineDesignatorOfBoardingPassIssuer(): Field | undefined;
98
+ /** Airline Numeric Code */
99
+ get airlineNumericCode(): Field | undefined;
100
+ /** Baggage Tag License Plate Numbers */
101
+ get baggageTagLicensePlateNumbers(): Field | undefined;
102
+ /** Check In Sequence Number */
103
+ get checkInSequenceNumber(): Field;
104
+ /** Compartment Code */
105
+ get compartmentCode(): Field;
106
+ /** Date Of Boarding Pass Issuance Julian */
107
+ get dateOfBoardingPassIssuanceJulian(): Field | undefined;
108
+ /** Date Of Flight Julian */
109
+ get dateOfFlightJulian(): Field;
110
+ /** Departure Airport Code */
111
+ get departureAirportCode(): Field;
112
+ /** Destination Airport Code */
113
+ get destinationAirportCode(): Field;
114
+ /** Document Form Serial Number */
115
+ get documentFormSerialNumber(): Field | undefined;
116
+ /** Document Type */
117
+ get documentType(): Field | undefined;
118
+ /** Fast Track */
119
+ get fastTrack(): Field | undefined;
120
+ /** First Non Consecutive Baggage Tag License Plate Number */
121
+ get firstNonConsecutiveBaggageTagLicensePlateNumber(): Field | undefined;
122
+ /** Flight Number */
123
+ get flightNumber(): Field;
124
+ /** For Individual Airline Use */
125
+ get forIndividualAirlineUse(): Field | undefined;
126
+ /** Free Baggage Allowance */
127
+ get freeBaggageAllowance(): Field | undefined;
128
+ /** Frequent Flyer Airline Designator */
129
+ get frequentFlyerAirlineDesignator(): Field | undefined;
130
+ /** Frequent Flyer Number */
131
+ get frequentFlyerNumber(): Field | undefined;
132
+ /** IDAD Indicator */
133
+ get idadIndicator(): Field | undefined;
134
+ /** International Documentation Verification */
135
+ get internationalDocumentationVerification(): Field | undefined;
136
+ /** Marketing Carrier Designator */
137
+ get marketingCarrierDesignator(): Field | undefined;
138
+ /** Operating Carrier Designator */
139
+ get operatingCarrierDesignator(): Field;
140
+ /** Operating Carrier PNR Code */
141
+ get operatingCarrierPNRCode(): Field;
142
+ /** Passenger Description */
143
+ get passengerDescription(): Field | undefined;
144
+ /** Passenger Status */
145
+ get passengerStatus(): Field;
146
+ /** Seat Number */
147
+ get seatNumber(): Field;
148
+ /** Second Non Consecutive Baggage Tag License Plate Number */
149
+ get secondNonConsecutiveBaggageTagLicensePlateNumber(): Field | undefined;
150
+ /** Selectee Indicator */
151
+ get selecteeIndicator(): Field | undefined;
152
+ /** Source Of Boarding Pass Issuance */
153
+ get sourceOfBoardingPassIssuance(): Field | undefined;
154
+ /** Source Of Check In */
155
+ get sourceOfCheckIn(): Field | undefined;
156
+ /** VersionNumber */
157
+ get versionNumber(): Field | undefined;
158
+ }
159
+ }
160
+ /** SwissQR */
161
+ export declare class SwissQR {
162
+ private _document;
163
+ get document(): GenericDocument;
164
+ constructor(document: GenericDocument);
165
+ requiredDocumentType(): string;
166
+ /** Additional Billing Information */
167
+ get additionalBillingInformation(): Field | undefined;
168
+ /** Additional Info Trailer */
169
+ get additionalInfoTrailer(): Field | undefined;
170
+ /** Additional Info Unstructured */
171
+ get additionalInfoUnstructured(): Field | undefined;
172
+ /** Alternative Procedure Parameter */
173
+ get alternativeProcedureParameter(): Field | undefined;
174
+ /** Amount */
175
+ get amount(): Field | undefined;
176
+ /** Currency */
177
+ get currency(): Field | undefined;
178
+ /** Debtor Address Type */
179
+ get debtorAddressType(): Field | undefined;
180
+ /** Debtor Building Or Address Line 2 */
181
+ get debtorBuildingOrAddressLine2(): Field | undefined;
182
+ /** Debtor Country */
183
+ get debtorCountry(): Field | undefined;
184
+ /** Debtor Name */
185
+ get debtorName(): Field | undefined;
186
+ /** Debtor Place */
187
+ get debtorPlace(): Field | undefined;
188
+ /** Debtor Postal Code */
189
+ get debtorPostalCode(): Field | undefined;
190
+ /** Debtor Street Or Address Line 1 */
191
+ get debtorStreetOrAddressLine1(): Field | undefined;
192
+ /** Due Date */
193
+ get dueDate(): Field | undefined;
194
+ /** Encoding */
195
+ get encoding(): Field | undefined;
196
+ /** Final Payee Address Type */
197
+ get finalPayeeAddressType(): Field | undefined;
198
+ /** Final Payee Building Or Address Line 2 */
199
+ get finalPayeeBuildingOrAddressLine2(): Field | undefined;
200
+ /** Final Payee Country */
201
+ get finalPayeeCountry(): Field | undefined;
202
+ /** Final Payee Name */
203
+ get finalPayeeName(): Field | undefined;
204
+ /** Final Payee Place */
205
+ get finalPayeePlace(): Field | undefined;
206
+ /** Final Payee Postal Code */
207
+ get finalPayeePostalCode(): Field | undefined;
208
+ /** Final Payee Street Or Address Line 1 */
209
+ get finalPayeeStreetOrAddressLine1(): Field | undefined;
210
+ /** IBAN */
211
+ get iban(): Field | undefined;
212
+ /** Major Version */
213
+ get majorVersion(): Field;
214
+ /** Payee Address Type */
215
+ get payeeAddressType(): Field | undefined;
216
+ /** Payee Building Or Address Line 2 */
217
+ get payeeBuildingOrAddressLine2(): Field | undefined;
218
+ /** Payee Country */
219
+ get payeeCountry(): Field | undefined;
220
+ /** Payee Name */
221
+ get payeeName(): Field | undefined;
222
+ /** Payee Place */
223
+ get payeePlace(): Field | undefined;
224
+ /** Payee Postal Code */
225
+ get payeePostalCode(): Field | undefined;
226
+ /** Payee Street Or Address Line 1 */
227
+ get payeeStreetOrAddressLine1(): Field | undefined;
228
+ /** Payment Reference */
229
+ get paymentReference(): Field | undefined;
230
+ /** Payment Reference Type */
231
+ get paymentReferenceType(): Field | undefined;
232
+ }
233
+ /** Medical Plan */
234
+ export declare class DEMedicalPlan {
235
+ private _document;
236
+ get document(): GenericDocument;
237
+ constructor(document: GenericDocument);
238
+ requiredDocumentType(): string;
239
+ /** Current Page */
240
+ get currentPage(): Field;
241
+ /** Document Version Number */
242
+ get documentVersionNumber(): Field;
243
+ /** GUID */
244
+ get guid(): Field;
245
+ /** Language Country Code */
246
+ get languageCountryCode(): Field;
247
+ /** Patch Version Number */
248
+ get patchVersionNumber(): Field;
249
+ /** Total Number Of Pages */
250
+ get totalNumberOfPages(): Field;
251
+ /** The child document of type "Patient". */
252
+ get patient(): DEMedicalPlan.Patient;
253
+ /** The child document of type "Doctor". */
254
+ get doctor(): DEMedicalPlan.Doctor;
255
+ /** An array of all children of type "Subheading". */
256
+ get subheadings(): DEMedicalPlan.Subheading[];
257
+ }
258
+ export declare namespace DEMedicalPlan {
259
+ /** Patient */
260
+ class Patient {
261
+ private _document;
262
+ get document(): GenericDocument;
263
+ constructor(document: GenericDocument);
264
+ requiredDocumentType(): string;
265
+ /** Allergies And Intolerances */
266
+ get allergiesAndIntolerances(): Field | undefined;
267
+ /** Birth Date */
268
+ get birthDate(): Field | undefined;
269
+ /** Breast Feeding */
270
+ get breastFeeding(): Field | undefined;
271
+ /** Creatinine Value */
272
+ get creatinineValue(): Field | undefined;
273
+ /** First Name */
274
+ get firstName(): Field | undefined;
275
+ /** Gender */
276
+ get gender(): Field | undefined;
277
+ /** Height */
278
+ get height(): Field | undefined;
279
+ /** Last Name */
280
+ get lastName(): Field | undefined;
281
+ /** Patient Free Text */
282
+ get patientFreeText(): Field | undefined;
283
+ /** Patient ID */
284
+ get patientID(): Field | undefined;
285
+ /** Pre Name */
286
+ get preName(): Field | undefined;
287
+ /** Pregnant */
288
+ get pregnant(): Field | undefined;
289
+ /** Name Suffix */
290
+ get suffix(): Field | undefined;
291
+ /** Title */
292
+ get title(): Field | undefined;
293
+ /** Weight */
294
+ get weight(): Field | undefined;
295
+ }
296
+ /** Doctor */
297
+ class Doctor {
298
+ private _document;
299
+ get document(): GenericDocument;
300
+ constructor(document: GenericDocument);
301
+ requiredDocumentType(): string;
302
+ /** Doctor Number */
303
+ get doctorNumber(): Field | undefined;
304
+ /** Email */
305
+ get email(): Field | undefined;
306
+ /** Hospital ID */
307
+ get hospitalID(): Field | undefined;
308
+ /** Issuer Name */
309
+ get issuerName(): Field | undefined;
310
+ /** Issuing Date And Time */
311
+ get issuingDateAndTime(): Field | undefined;
312
+ /** Pharmacy ID */
313
+ get pharmacyID(): Field | undefined;
314
+ /** Place */
315
+ get place(): Field | undefined;
316
+ /** Postal Code */
317
+ get postalCode(): Field | undefined;
318
+ /** Street */
319
+ get street(): Field | undefined;
320
+ /** Telephone Number */
321
+ get telephoneNumber(): Field | undefined;
322
+ }
323
+ /** Subheading */
324
+ class Subheading {
325
+ private _document;
326
+ get document(): GenericDocument;
327
+ constructor(document: GenericDocument);
328
+ requiredDocumentType(): string;
329
+ /** General Note */
330
+ get generalNotes(): Field[];
331
+ /** Key Words */
332
+ get keyWords(): Field | undefined;
333
+ /** Subheading Free Text */
334
+ get subheadingFreeText(): Field | undefined;
335
+ /** An array of all children of type "Medicine". */
336
+ get medicines(): DEMedicalPlan.Subheading.Medicine[];
337
+ /** An array of all children of type "Prescription". */
338
+ get prescriptions(): DEMedicalPlan.Subheading.Prescription[];
339
+ }
340
+ namespace Subheading {
341
+ /** Medicine */
342
+ class Medicine {
343
+ private _document;
344
+ get document(): GenericDocument;
345
+ constructor(document: GenericDocument);
346
+ requiredDocumentType(): string;
347
+ /** Dosage Form */
348
+ get dosageForm(): Field | undefined;
349
+ /** Dosage Form Free Text */
350
+ get dosageFormFreeText(): Field | undefined;
351
+ /** Dosage Free Text */
352
+ get dosageFreeText(): Field | undefined;
353
+ /** Dosing Unit */
354
+ get dosingUnit(): Field | undefined;
355
+ /** Dosing Unit Free Text */
356
+ get dosingUnitFreeText(): Field | undefined;
357
+ /** Drug Name */
358
+ get drugName(): Field | undefined;
359
+ /** Evening Intake Dose */
360
+ get evening(): Field | undefined;
361
+ /** General Notes */
362
+ get generalNotes(): Field | undefined;
363
+ /** Midday Intake Dose */
364
+ get midday(): Field | undefined;
365
+ /** Morning Intake Dose */
366
+ get morning(): Field | undefined;
367
+ /** Night Intake Dose */
368
+ get night(): Field | undefined;
369
+ /** Pharmaceutical Number */
370
+ get pharmaceuticalNumber(): Field | undefined;
371
+ /** Reason For Treatment */
372
+ get reasonForTreatment(): Field | undefined;
373
+ /** Relevant Info */
374
+ get relevantInfo(): Field | undefined;
375
+ /** An array of all children of type "Substance". */
376
+ get substances(): DEMedicalPlan.Subheading.Medicine.Substance[];
377
+ }
378
+ namespace Medicine {
379
+ /** Substance */
380
+ class Substance {
381
+ private _document;
382
+ get document(): GenericDocument;
383
+ constructor(document: GenericDocument);
384
+ requiredDocumentType(): string;
385
+ /** Active Substance */
386
+ get activeSubstance(): Field | undefined;
387
+ /** Potency */
388
+ get potency(): Field | undefined;
389
+ }
390
+ }
391
+ /** Prescription */
392
+ class Prescription {
393
+ private _document;
394
+ get document(): GenericDocument;
395
+ constructor(document: GenericDocument);
396
+ requiredDocumentType(): string;
397
+ /** General Information */
398
+ get generalInformation(): Field | undefined;
399
+ /** Prescription Free Text */
400
+ get prescriptionFreeText(): Field | undefined;
401
+ }
402
+ }
403
+ }
404
+ /** ID Card */
405
+ export declare class IDCardPDF417 {
406
+ private _document;
407
+ get document(): GenericDocument;
408
+ constructor(document: GenericDocument);
409
+ requiredDocumentType(): string;
410
+ /** Birth Date. The format is ISO8601 with delimiters */
411
+ get birthDate(): Field;
412
+ /** Date Expired. The format is ISO8601 with delimiters */
413
+ get dateExpired(): Field;
414
+ /** Date Issued. The format is ISO8601 with delimiters */
415
+ get dateIssued(): Field;
416
+ /** Document Code */
417
+ get documentCode(): Field;
418
+ /** First Name */
419
+ get firstName(): Field;
420
+ /** Last Name */
421
+ get lastName(): Field;
422
+ /** Optional */
423
+ get optional(): Field;
424
+ }
425
+ /** GS1 */
426
+ export declare class GS1 {
427
+ private _document;
428
+ get document(): GenericDocument;
429
+ constructor(document: GenericDocument);
430
+ requiredDocumentType(): string;
431
+ /** An array of all children of type "Element". */
432
+ get elements(): GS1.Element[];
433
+ }
434
+ export declare namespace GS1 {
435
+ /** GS1 Element */
436
+ class Element {
437
+ private _document;
438
+ get document(): GenericDocument;
439
+ constructor(document: GenericDocument);
440
+ requiredDocumentType(): string;
441
+ /** Application Identifier */
442
+ get applicationIdentifier(): Field;
443
+ /** Data Title */
444
+ get dataTitle(): Field;
445
+ /** Description */
446
+ get elementDescription(): Field;
447
+ /** Raw Value */
448
+ get rawValue(): Field;
449
+ /** An array of all children of type "ValidationError". */
450
+ get validationErrors(): GS1.Element.ValidationError[];
451
+ }
452
+ namespace Element {
453
+ /** Validation Errors */
454
+ class ValidationError {
455
+ private _document;
456
+ get document(): GenericDocument;
457
+ constructor(document: GenericDocument);
458
+ requiredDocumentType(): string;
459
+ /** Error Code */
460
+ get code(): Field;
461
+ /** Reason */
462
+ get reason(): Field;
463
+ }
464
+ }
465
+ }
466
+ /** SEPA */
467
+ export declare class SEPA {
468
+ private _document;
469
+ get document(): GenericDocument;
470
+ constructor(document: GenericDocument);
471
+ requiredDocumentType(): string;
472
+ /** Amount */
473
+ get amount(): Field | undefined;
474
+ /** Character Set */
475
+ get characterSet(): Field;
476
+ /** Identification */
477
+ get identification(): Field;
478
+ /** Information */
479
+ get information(): Field | undefined;
480
+ /** Amount */
481
+ get purpose(): Field | undefined;
482
+ /** Receiver BIC */
483
+ get receiverBIC(): Field;
484
+ /** Receiver IBAN */
485
+ get receiverIBAN(): Field;
486
+ /** Receiver Name */
487
+ get receiverName(): Field;
488
+ /** Remittance */
489
+ get remittance(): Field | undefined;
490
+ /** Service Tag */
491
+ get serviceTag(): Field;
492
+ /** Version */
493
+ get version(): Field;
494
+ }
495
+ /** Medical Certificate */
496
+ export declare class MedicalCertificate {
497
+ private _document;
498
+ get document(): GenericDocument;
499
+ constructor(document: GenericDocument);
500
+ requiredDocumentType(): string;
501
+ /** Accident */
502
+ get accident(): Field | undefined;
503
+ /** Assigned To Accident Insurance Doctor */
504
+ get assignedToAccidentInsuranceDoctor(): Field | undefined;
505
+ /** Birth Date. The format is ISO8601 with delimiters */
506
+ get birthDate(): Field | undefined;
507
+ /** Child Needs Care From */
508
+ get childNeedsCareFrom(): Field | undefined;
509
+ /** Child Needs Care Until */
510
+ get childNeedsCareUntil(): Field | undefined;
511
+ /** Diagnose */
512
+ get diagnose(): Field | undefined;
513
+ /** Diagnosed On. The format is ISO8601 with delimiters */
514
+ get diagnosedOn(): Field | undefined;
515
+ /** Doctor Number */
516
+ get doctorNumber(): Field | undefined;
517
+ /** Document Date. The format is ISO8601 with delimiters */
518
+ get documentDate(): Field | undefined;
519
+ /** First Name */
520
+ get firstName(): Field | undefined;
521
+ /** Health Insurance Number */
522
+ get healthInsuranceNumber(): Field | undefined;
523
+ /** Incapable Of Work Since. The format is ISO8601 with delimiters */
524
+ get incapableOfWorkSince(): Field | undefined;
525
+ /** Incapable Of Work Until. The format is ISO8601 with delimiters */
526
+ get incapableOfWorkUntil(): Field | undefined;
527
+ /** Initial Certificate */
528
+ get initialCertificate(): Field | undefined;
529
+ /** Insured Person Number */
530
+ get insuredPersonNumber(): Field | undefined;
531
+ /** Last Name */
532
+ get lastName(): Field | undefined;
533
+ /** Place Of Operation Number */
534
+ get placeOfOperationNumber(): Field | undefined;
535
+ /** Renewed Certificate */
536
+ get renewedCertificate(): Field | undefined;
537
+ /** Requires Care */
538
+ get requiresCare(): Field | undefined;
539
+ /** Status */
540
+ get status(): Field | undefined;
541
+ /** Work Accident */
542
+ get workAccident(): Field | undefined;
543
+ }
544
+ /** VCard */
545
+ export declare class VCard {
546
+ private _document;
547
+ get document(): GenericDocument;
548
+ constructor(document: GenericDocument);
549
+ requiredDocumentType(): string;
550
+ /** The child document of type "Version". */
551
+ get version(): VCard.Version;
552
+ /** The child document of type "Source". */
553
+ get source(): VCard.Source | undefined;
554
+ /** The child document of type "Kind". */
555
+ get kind(): VCard.Kind | undefined;
556
+ /** The child document of type "XML". */
557
+ get xml(): VCard.XML | undefined;
558
+ /** The child document of type "Name". */
559
+ get name(): VCard.Name | undefined;
560
+ /** The child document of type "FirstName". */
561
+ get firstName(): VCard.FirstName | undefined;
562
+ /** The child document of type "Nickname". */
563
+ get nickname(): VCard.Nickname | undefined;
564
+ /** The child document of type "Birthday". */
565
+ get birthday(): VCard.Birthday | undefined;
566
+ /** The child document of type "Anniversary". */
567
+ get anniversary(): VCard.Anniversary | undefined;
568
+ /** The child document of type "Gender". */
569
+ get gender(): VCard.Gender | undefined;
570
+ /** The child document of type "DeliveryAddress". */
571
+ get deliveryAddress(): VCard.DeliveryAddress | undefined;
572
+ /** The child document of type "Photo". */
573
+ get photo(): VCard.Photo | undefined;
574
+ /** The child document of type "TelephoneNumber". */
575
+ get telephoneNumber(): VCard.TelephoneNumber | undefined;
576
+ /** The child document of type "Email". */
577
+ get email(): VCard.Email | undefined;
578
+ /** The child document of type "IMPP". */
579
+ get impp(): VCard.IMPP | undefined;
580
+ /** The child document of type "Languages". */
581
+ get languages(): VCard.Languages | undefined;
582
+ /** The child document of type "TimeZone". */
583
+ get timeZone(): VCard.TimeZone | undefined;
584
+ /** The child document of type "GeoLocation". */
585
+ get geoLocation(): VCard.GeoLocation | undefined;
586
+ /** The child document of type "Title". */
587
+ get title(): VCard.Title | undefined;
588
+ /** The child document of type "Role". */
589
+ get role(): VCard.Role | undefined;
590
+ /** The child document of type "Logo". */
591
+ get logo(): VCard.Logo | undefined;
592
+ /** The child document of type "Organisation". */
593
+ get organisation(): VCard.Organisation | undefined;
594
+ /** The child document of type "Member". */
595
+ get member(): VCard.Member | undefined;
596
+ /** The child document of type "Related". */
597
+ get related(): VCard.Related | undefined;
598
+ /** The child document of type "Categories". */
599
+ get categories(): VCard.Categories | undefined;
600
+ /** The child document of type "Note". */
601
+ get note(): VCard.Note | undefined;
602
+ /** The child document of type "ProductId". */
603
+ get productId(): VCard.ProductId | undefined;
604
+ /** The child document of type "Revision". */
605
+ get revision(): VCard.Revision | undefined;
606
+ /** The child document of type "Sound". */
607
+ get sound(): VCard.Sound | undefined;
608
+ /** The child document of type "UID". */
609
+ get uid(): VCard.UID | undefined;
610
+ /** The child document of type "ClientPIDMap". */
611
+ get clientPIDMap(): VCard.ClientPIDMap | undefined;
612
+ /** The child document of type "URL". */
613
+ get url(): VCard.URL | undefined;
614
+ /** The child document of type "PublicKey". */
615
+ get publicKey(): VCard.PublicKey | undefined;
616
+ /** The child document of type "BusyTimeURL". */
617
+ get busyTimeURL(): VCard.BusyTimeURL | undefined;
618
+ /** The child document of type "CalendarURIForRequests". */
619
+ get calendarURIForRequests(): VCard.CalendarURIForRequests | undefined;
620
+ /** The child document of type "CalendarURI". */
621
+ get calendarURI(): VCard.CalendarURI | undefined;
622
+ /** An array of all children of type "Custom". */
623
+ get customs(): VCard.Custom[];
624
+ }
625
+ export declare namespace VCard {
626
+ /** VCard Entry */
627
+ abstract class Entry {
628
+ private _document;
629
+ get document(): GenericDocument;
630
+ constructor(document: GenericDocument);
631
+ abstract requiredDocumentType(): string;
632
+ /** Raw Value */
633
+ get rawValue(): Field;
634
+ /** Type Modifier */
635
+ get typeModifiers(): Field[];
636
+ /** Value */
637
+ get values(): Field[];
638
+ }
639
+ /** Version */
640
+ class Version extends Entry {
641
+ constructor(document: GenericDocument);
642
+ requiredDocumentType(): string;
643
+ }
644
+ /** Source */
645
+ class Source extends Entry {
646
+ constructor(document: GenericDocument);
647
+ requiredDocumentType(): string;
648
+ }
649
+ /** Kind */
650
+ class Kind extends Entry {
651
+ constructor(document: GenericDocument);
652
+ requiredDocumentType(): string;
653
+ }
654
+ /** XML */
655
+ class XML extends Entry {
656
+ constructor(document: GenericDocument);
657
+ requiredDocumentType(): string;
658
+ }
659
+ /** Name */
660
+ class Name extends Entry {
661
+ constructor(document: GenericDocument);
662
+ requiredDocumentType(): string;
663
+ }
664
+ /** First Name */
665
+ class FirstName extends Entry {
666
+ constructor(document: GenericDocument);
667
+ requiredDocumentType(): string;
668
+ }
669
+ /** Nickname */
670
+ class Nickname extends Entry {
671
+ constructor(document: GenericDocument);
672
+ requiredDocumentType(): string;
673
+ }
674
+ /** Birthday */
675
+ class Birthday extends Entry {
676
+ constructor(document: GenericDocument);
677
+ requiredDocumentType(): string;
678
+ }
679
+ /** Anniversary */
680
+ class Anniversary extends Entry {
681
+ constructor(document: GenericDocument);
682
+ requiredDocumentType(): string;
683
+ }
684
+ /** Gender */
685
+ class Gender extends Entry {
686
+ constructor(document: GenericDocument);
687
+ requiredDocumentType(): string;
688
+ }
689
+ /** Delivery Address */
690
+ class DeliveryAddress extends Entry {
691
+ constructor(document: GenericDocument);
692
+ requiredDocumentType(): string;
693
+ }
694
+ /** Photo */
695
+ class Photo extends Entry {
696
+ constructor(document: GenericDocument);
697
+ requiredDocumentType(): string;
698
+ }
699
+ /** Telephone Number */
700
+ class TelephoneNumber extends Entry {
701
+ constructor(document: GenericDocument);
702
+ requiredDocumentType(): string;
703
+ }
704
+ /** Email */
705
+ class Email extends Entry {
706
+ constructor(document: GenericDocument);
707
+ requiredDocumentType(): string;
708
+ }
709
+ /** IMPP */
710
+ class IMPP extends Entry {
711
+ constructor(document: GenericDocument);
712
+ requiredDocumentType(): string;
713
+ }
714
+ /** Languages */
715
+ class Languages extends Entry {
716
+ constructor(document: GenericDocument);
717
+ requiredDocumentType(): string;
718
+ }
719
+ /** Time Zone */
720
+ class TimeZone extends Entry {
721
+ constructor(document: GenericDocument);
722
+ requiredDocumentType(): string;
723
+ }
724
+ /** Geo Location */
725
+ class GeoLocation extends Entry {
726
+ constructor(document: GenericDocument);
727
+ requiredDocumentType(): string;
728
+ }
729
+ /** Title */
730
+ class Title extends Entry {
731
+ constructor(document: GenericDocument);
732
+ requiredDocumentType(): string;
733
+ }
734
+ /** Role */
735
+ class Role extends Entry {
736
+ constructor(document: GenericDocument);
737
+ requiredDocumentType(): string;
738
+ }
739
+ /** Logo */
740
+ class Logo extends Entry {
741
+ constructor(document: GenericDocument);
742
+ requiredDocumentType(): string;
743
+ }
744
+ /** Organisation */
745
+ class Organisation extends Entry {
746
+ constructor(document: GenericDocument);
747
+ requiredDocumentType(): string;
748
+ }
749
+ /** Member */
750
+ class Member extends Entry {
751
+ constructor(document: GenericDocument);
752
+ requiredDocumentType(): string;
753
+ }
754
+ /** Related */
755
+ class Related extends Entry {
756
+ constructor(document: GenericDocument);
757
+ requiredDocumentType(): string;
758
+ }
759
+ /** Categories */
760
+ class Categories extends Entry {
761
+ constructor(document: GenericDocument);
762
+ requiredDocumentType(): string;
763
+ }
764
+ /** Note */
765
+ class Note extends Entry {
766
+ constructor(document: GenericDocument);
767
+ requiredDocumentType(): string;
768
+ }
769
+ /** ProductId */
770
+ class ProductId extends Entry {
771
+ constructor(document: GenericDocument);
772
+ requiredDocumentType(): string;
773
+ }
774
+ /** Revision */
775
+ class Revision extends Entry {
776
+ constructor(document: GenericDocument);
777
+ requiredDocumentType(): string;
778
+ }
779
+ /** Sound */
780
+ class Sound extends Entry {
781
+ constructor(document: GenericDocument);
782
+ requiredDocumentType(): string;
783
+ }
784
+ /** UID */
785
+ class UID extends Entry {
786
+ constructor(document: GenericDocument);
787
+ requiredDocumentType(): string;
788
+ }
789
+ /** Client PID Map */
790
+ class ClientPIDMap extends Entry {
791
+ constructor(document: GenericDocument);
792
+ requiredDocumentType(): string;
793
+ }
794
+ /** URL */
795
+ class URL extends Entry {
796
+ constructor(document: GenericDocument);
797
+ requiredDocumentType(): string;
798
+ }
799
+ /** Public Key */
800
+ class PublicKey extends Entry {
801
+ constructor(document: GenericDocument);
802
+ requiredDocumentType(): string;
803
+ }
804
+ /** Busy Time URL */
805
+ class BusyTimeURL extends Entry {
806
+ constructor(document: GenericDocument);
807
+ requiredDocumentType(): string;
808
+ }
809
+ /** Calendar URI For Requests */
810
+ class CalendarURIForRequests extends Entry {
811
+ constructor(document: GenericDocument);
812
+ requiredDocumentType(): string;
813
+ }
814
+ /** Calendar URI */
815
+ class CalendarURI extends Entry {
816
+ constructor(document: GenericDocument);
817
+ requiredDocumentType(): string;
818
+ }
819
+ /** Custom */
820
+ class Custom extends Entry {
821
+ constructor(document: GenericDocument);
822
+ requiredDocumentType(): string;
823
+ }
824
+ }
825
+ /** AAMVA */
826
+ export declare class AAMVA {
827
+ private _document;
828
+ get document(): GenericDocument;
829
+ constructor(document: GenericDocument);
830
+ requiredDocumentType(): string;
831
+ /** Issuer Identification Number */
832
+ get issuerIdentificationNumber(): Field;
833
+ /** Jurisdiction Version Number */
834
+ get jurisdictionVersionNumber(): Field | undefined;
835
+ /** Version */
836
+ get version(): Field;
837
+ /** The child document of type "TitleData". */
838
+ get titleData(): AAMVA.TitleData | undefined;
839
+ /** The child document of type "RegistrationData". */
840
+ get registrationData(): AAMVA.RegistrationData | undefined;
841
+ /** The child document of type "MotorCarrierData". */
842
+ get motorCarrierData(): AAMVA.MotorCarrierData | undefined;
843
+ /** The child document of type "RegistrantAndVehicleData". */
844
+ get registrantAndVehicleData(): AAMVA.RegistrantAndVehicleData | undefined;
845
+ /** The child document of type "VehicleOwnerData". */
846
+ get vehicleOwnerData(): AAMVA.VehicleOwnerData | undefined;
847
+ /** The child document of type "VehicleData". */
848
+ get vehicleData(): AAMVA.VehicleData | undefined;
849
+ /** The child document of type "VehicleSafetyInspectionData". */
850
+ get vehicleSafetyInspectionData(): AAMVA.VehicleSafetyInspectionData | undefined;
851
+ /** The child document of type "DriverLicense". */
852
+ get driverLicense(): AAMVA.DriverLicense | undefined;
853
+ /** The child document of type "IDCard". */
854
+ get idCard(): AAMVA.IDCard | undefined;
855
+ /** The child document of type "EnhancedDriverLicense". */
856
+ get enhancedDriverLicense(): AAMVA.EnhancedDriverLicense | undefined;
857
+ /** The child document of type "RawDocument". */
858
+ get rawDocument(): AAMVA.RawDocument;
859
+ }
860
+ export declare namespace AAMVA {
861
+ /** Title Data. File type "TD". */
862
+ class TitleData {
863
+ private _document;
864
+ get document(): GenericDocument;
865
+ constructor(document: GenericDocument);
866
+ requiredDocumentType(): string;
867
+ /** Data element ID "NAT". City portion of the owner’s address. */
868
+ get addressCity(): Field | undefined;
869
+ /** Data element ID "NAU". Jurisdiction portion of the owner’s address. */
870
+ get addressJurisdictionCode(): Field | undefined;
871
+ /** Data element ID "NAR". Street portion of the owner’s address. */
872
+ get addressStreet(): Field | undefined;
873
+ /** Data element ID "NAV". The ZIP code or Postal code portion of the owner’s address. */
874
+ get addressZipCode(): Field | undefined;
875
+ /** Data element ID "BBC". The name of business that owns the vehicle. */
876
+ get businessName(): Field | undefined;
877
+ /** Data element ID "NAA". Family name (commonly called surname or last name) of the owner of the vehicle. */
878
+ get familyName(): Field | undefined;
879
+ /** Data element ID "LAF". A code that uniquely identifies the first holder of a lien. */
880
+ get firstLienHolderId(): Field | undefined;
881
+ /** Data element ID "LAA". Name of the first lien holder of the vehicle. */
882
+ get firstLienHolderName(): Field | undefined;
883
+ /** Data element ID "NAE". Given name or names (includes all of what are commonly referred to as first and middle names) of the owner of the vehicle. */
884
+ get givenName(): Field | undefined;
885
+ /** Data element ID "TAW". This code represents whether the vehicle/vessel is new or used. Note: jurisdictions’ definitions of these classifications may vary a little due to state regulations on demo vehicles, slates between dealers, application of state taxes, etc. N = New, U = Used. */
886
+ get newUsedIndicator(): Field | undefined;
887
+ /** Data element ID "TAH". The date the odometer reading was recorded by the jurisdiction. */
888
+ get odometerDate(): Field | undefined;
889
+ /** Data element ID "TAG". This is the federal odometer mileage disclosure. The mandatory information is: (1) Actual vehicle mileage; (2) Mileage exceeds mechanical limitations; (3) Not actual mileage; (4) Mileage disclosure not required. */
890
+ get odometerDisclosure(): Field | undefined;
891
+ /** Data element ID "TAI". This is the odometer reading registered with the DMV either at the time of titling or registration renewal in kilometers. */
892
+ get odometerReadingKilometers(): Field | undefined;
893
+ /** Data element ID "TAF". This is the odometer reading registered with the DMV either at the time of titling or registration renewal. */
894
+ get odometerReadingMileage(): Field | undefined;
895
+ /** Data element ID "TAZ". The title number assigned to the vehicle by the previous titling jurisdiction. */
896
+ get previousTitleNumber(): Field | undefined;
897
+ /** Data element ID "TPJ". The code for the jurisdiction (U.S., Canadian, or Mexican) that titled the vehicle immediately prior to the current titling jurisdiction. */
898
+ get previousTitlingJurisdiction(): Field | undefined;
899
+ /** Data element ID "TAY". Code providing information about the brand applied to the title. */
900
+ get titleBrand(): Field | undefined;
901
+ /** Data element ID "TAV". The date the jurisdiction’s titling authority issued a title to the owner of the vehicle. The format is CCYYMMDD. */
902
+ get titleIssueDate(): Field | undefined;
903
+ /** Data element ID "TAA". The date the jurisdiction’s titling authority issued a title to the owner of the vehicle. The format is CCYYMMDD. */
904
+ get titleNumber(): Field | undefined;
905
+ /** Data element ID "TAC". A unique set of alphanumeric characters assigned by the titling jurisdiction to the certificate of title of a vehicle. */
906
+ get titlingJurisdiction(): Field | undefined;
907
+ /** Data element ID "VAO". The general configuration or shape of a vehicle distinguished by characteristics such as number of doors, seats, windows, roofline, and type of top. The vehicle body type is 2-character alphanumeric. */
908
+ get vehicleBodyStyle(): Field | undefined;
909
+ /** Data element ID "VBD". Where the vehicle/vessel is one color, this is the appropriate code describing that color. When the vehicle is two colors, this is the code for the top-most or front-most color. */
910
+ get vehicleColor(): Field | undefined;
911
+ /** Data element ID "VAD". A unique combination of alphanumeric characters that identifies a specific vehicle or component. The VIN is affixed to the vehicle in specific locations and formulated by the manufacturer. State agencies under some controlled instances may assign a VIN to a vehicle. */
912
+ get vehicleIdentificationNumber(): Field | undefined;
913
+ /** Data element ID "VAK". The distinctive (coded) name applied to a group of vehicles by a manufacturer. */
914
+ get vehicleMake(): Field | undefined;
915
+ /** Data element ID "VAM". A code denoting a family of vehicles (within a make), which has a degree of similarity in construction, such as body, chassis, etc. The field does not necessarily contain a standard code; it may contain a value provided by the originator of the field. */
916
+ get vehicleModel(): Field | undefined;
917
+ /** Data element ID "VAL". The year that is assigned to a vehicle by the manufacturer. The format is CCYY. */
918
+ get vehicleModelYear(): Field | undefined;
919
+ /** Data element ID "TAU". The date a vehicle was purchased by the current owner. The format is ISO8601 with delimiters. */
920
+ get vehiclePurchaseDate(): Field | undefined;
921
+ }
922
+ /** Registration Data. File type "RG". */
923
+ class RegistrationData {
924
+ private _document;
925
+ get document(): GenericDocument;
926
+ constructor(document: GenericDocument);
927
+ requiredDocumentType(): string;
928
+ /** Data element ID "RBK". City portion of the owner’s address. */
929
+ get addressCity(): Field | undefined;
930
+ /** Data element ID "RBL". Jurisdiction portion of the owner’s address. */
931
+ get addressJurisdictionCode(): Field | undefined;
932
+ /** Data element ID "RBI". Street portion of the owner’s address. */
933
+ get addressStreet(): Field | undefined;
934
+ /** Data element ID "RBM". The Zip code or Postal code of the vehicle owner’s residence address. */
935
+ get addressZipCode(): Field | undefined;
936
+ /** Data element ID "VBC". The number of common axles of rotation of one or more wheels of a vehicle, whether power driven or freely rotating. */
937
+ get axles(): Field | undefined;
938
+ /** Data element ID "BBC". The business name of the first registrant of a vehicle. */
939
+ get businessName(): Field | undefined;
940
+ /** Data element ID "FUL". The type of fuel used by the vehicle. In most cases, the fuel type would be diesel. */
941
+ get fuel(): Field | undefined;
942
+ /** Data element ID "VAT". The unladen weight of the vehicle (e.g., the single-unit truck, truck combination) plus the weight of the load being carried at a specific point in time. */
943
+ get grossVehicleWeight(): Field | undefined;
944
+ /** Data element ID "RBD". Family name (commonly called surname or last name) of the registered owner of a vehicle. */
945
+ get registrantFamilyName(): Field | undefined;
946
+ /** Data element ID "RBE". Given name or names (includes all of what are commonly referred to as first and middle names) of the registered owner of a vehicle. */
947
+ get registrantGivenName(): Field | undefined;
948
+ /** Data element ID "RAG". The date in which the registration expired. The format is ISO8601 with delimiters. */
949
+ get registrationExpiryDate(): Field | undefined;
950
+ /** Data element ID "RBB". The date in which the registration was issued. The format is ISO8601 with delimiters. */
951
+ get registrationIssueDate(): Field | undefined;
952
+ /** Data element ID "RAM". The characters assigned to a registration plate or tag affixed to the vehicle, assigned by the jurisdiction. */
953
+ get registrationPlateNumber(): Field | undefined;
954
+ /** Data element ID "RBU". A unique number printed on the tab/decal and stored as part of the registration record. */
955
+ get registrationWindowStickerDecal(): Field | undefined;
956
+ /** Data element ID "RBT". The year of registration. */
957
+ get registrationYear(): Field | undefined;
958
+ /** Data element ID "VAO". The general configuration or shape of a vehicle distinguished by characteristics such as number of doors, seats, windows, roofline, and type of top. The vehicle body type is 2-character alphanumeric. */
959
+ get vehicleBodyStyle(): Field | undefined;
960
+ /** Data element ID "VBD". Where the vehicle is one color, this is the appropriate code describing that color. When the vehicle is two colors, this is the code for the top-most or front-most color. */
961
+ get vehicleColor(): Field | undefined;
962
+ /** Data element ID "VAD". A unique combination of alphanumeric characters that identifies a specific vehicle or component. The VIN is affixed to the vehicle in specific locations and formulated by the manufacturer. State agencies under some controlled instances my assign a VIN to a vehicle. */
963
+ get vehicleIdentificationNumber(): Field | undefined;
964
+ /** Data element ID "VAK". The distinctive (coded) name applied to a group of vehicles by a manufacturer. */
965
+ get vehicleMake(): Field | undefined;
966
+ /** Data element ID "VAM". A code denoting a family of vehicles (within a make), which has a degree of similarity in construction, such as body, chassis, etc. The field does not necessarily contain a standard code; it may contain a value provided by the originator of the field. */
967
+ get vehicleModel(): Field | undefined;
968
+ /** Data element ID "VAL". The year which is assigned to a vehicle by the manufacturer. The format is CCYY. */
969
+ get vehicleModelYear(): Field | undefined;
970
+ /** Data element ID "VPC". Indicates the use of the vehicle. */
971
+ get vehicleUse(): Field | undefined;
972
+ }
973
+ /** Motor Carrier Data. File type "MC". */
974
+ class MotorCarrierData {
975
+ private _document;
976
+ get document(): GenericDocument;
977
+ constructor(document: GenericDocument);
978
+ requiredDocumentType(): string;
979
+ /** Data element ID "MAA". The name of the carrier responsible for safety. This can be an individual, partnership or corporation responsible for the transportation of persons or property. This is the name that is recognized by law. */
980
+ get carrierName(): Field | undefined;
981
+ /** Data element ID "MAL". This is the city for the mailing address of the individual carrier. This information is utilized by the base jurisdiction to send information to the carrier that purchased the IRP credentials. */
982
+ get city(): Field | undefined;
983
+ /** Data element ID "MAI". This is the jurisdiction of the residential address of the individual carrier. This information is utilized by the base jurisdiction to send information to the carrier that purchased the IRP credentials. */
984
+ get jurisdiction(): Field | undefined;
985
+ /** Data element ID "MAK". This is the mailing address of the individual carrier. This information is utilized by the base jurisdiction to send information to the carrier that purchased the IRP credentials. */
986
+ get streetAddress(): Field | undefined;
987
+ /** Data element ID "MAN". A unique identifier assigned to the carrier responsible for safety issued by the U.S. Department of Transportation – Federal Motor Carrier Safety Administration. */
988
+ get usdotNumber(): Field | undefined;
989
+ /** Data element ID "MAO". The ZIP or Postal code of the resident address of the vehicle owner. */
990
+ get zip(): Field | undefined;
991
+ }
992
+ /** Registrant And Vehicle Data. File type "IR". */
993
+ class RegistrantAndVehicleData {
994
+ private _document;
995
+ get document(): GenericDocument;
996
+ constructor(document: GenericDocument);
997
+ requiredDocumentType(): string;
998
+ /** Data element ID "RBI". The first line of the registrant’s residence address. */
999
+ get address(): Field | undefined;
1000
+ /** Data element ID "RAU". The declared base jurisdiction registration weight. */
1001
+ get baseJurisdictionRegisteredWeight(): Field | undefined;
1002
+ /** Data element ID "RBC". The name of the first registrant of a vehicle. Registrant’s name may be a combined individual name or the name of a business */
1003
+ get carrierNameRegistrant(): Field | undefined;
1004
+ /** Data element ID "RBK". The registrant’s residence city name. */
1005
+ get city(): Field | undefined;
1006
+ /** Data element ID "VAT". The unladen weight of the vehicle (e.g., single-unit truck, truck combination) plus the weight of the maximum load for which vehicle registration fees have been paid within a particular jurisdiction. */
1007
+ get grossVehicleWeight(): Field | undefined;
1008
+ /** Data element ID "RBL". The state or province of the registrant’s residence address. */
1009
+ get jurisdiction(): Field | undefined;
1010
+ /** Data element ID "VAL". The year which is assigned to a vehicle by the manufacturer. The format is YY. */
1011
+ get modelYear(): Field | undefined;
1012
+ /** Data element IDs "RAP", "VBC". The seat capacity of a commercial vehicle designed for transportation of more than then passengers. The number of common axles of rotation of one or more wheels of a vehicle, whether power design or freely rotating. */
1013
+ get numberOfSeats(): Field | undefined;
1014
+ /** Data element ID "RAD". The number assigned to the registration decal in those jurisdictions that issue decals. */
1015
+ get registrationDecalNumber(): Field | undefined;
1016
+ /** Data element ID "RAF". The registration enforcement date is the date that the current registration was enforced. This may or may not be the original registration date. The format is ISO8601 with delimiters */
1017
+ get registrationEnforcementDate(): Field | undefined;
1018
+ /** Data element ID "RAG". The date in which the registration expired. The format is ISO8601 with delimiters. */
1019
+ get registrationExpirationDate(): Field | undefined;
1020
+ /** Data element ID "IFJ". The date in which the registration was issued. The format is ISO8601 with delimiters. */
1021
+ get registrationIssueDate(): Field | undefined;
1022
+ /** Data element ID "RAM". The characters assigned to a registration plate or tag affixed to the vehicle, assigned by the jurisdiction. */
1023
+ get registrationPlateNumber(): Field | undefined;
1024
+ /** Data element ID "RBT". This field is the registration year assigned by the jurisdiction. The format is CCYY. */
1025
+ get registrationYear(): Field | undefined;
1026
+ /** Data element ID "VBB". The type of vehicle operated for the transportation of persons or property in the furtherance of any commercial or industrial enterprise, for hire or not for hire. Not all states will use all values. */
1027
+ get typeOfVehicle(): Field | undefined;
1028
+ /** Data element ID "IEG". A number, assigned by the registrant of the commercial vehicle or trailer, to identify the vehicle or trailer in the fleet. No two units in a fleet can have the same number. A.K.A vehicle unit number or owner’s equipment number. */
1029
+ get unitNumber(): Field | undefined;
1030
+ /** Data element ID "VAD". A unique combination of alphanumeric characters that identifies a specific vehicle or component. The VIN is affixed to the vehicle in specific locations and formulated by the manufacturer. State agencies under some controlled instances may assign a VIN to a vehicle. */
1031
+ get vehicleIdentificationNumber(): Field | undefined;
1032
+ /** Data element ID "VAK". The distinctive (coded) name applied to a group of vehicles by a manufacturer. */
1033
+ get vehicleMake(): Field | undefined;
1034
+ /** Data element ID "RBM". The ZIP or Postal code of the resident address of the registrant. */
1035
+ get zipCode(): Field | undefined;
1036
+ }
1037
+ /** Vehicle Owner Data. File type "OW". */
1038
+ class VehicleOwnerData {
1039
+ private _document;
1040
+ get document(): GenericDocument;
1041
+ constructor(document: GenericDocument);
1042
+ requiredDocumentType(): string;
1043
+ /** Data element ID "NAX". The unique customer number/ID of the first vehicle owner. */
1044
+ get firstOwnerIdNumber(): Field | undefined;
1045
+ /** Data element ID "NAB". Last Name or Surname of the Owner. Hyphenated names acceptable, spaces between names acceptable, but no other use of special symbols. */
1046
+ get firstOwnerLastName(): Field | undefined;
1047
+ /** Data element ID "NBA". The legal status of the first vehicle owner. This is only used when a vehicle has multiple owners. A legal status may be ("AND", "OR"). */
1048
+ get firstOwnerLegalStatus(): Field | undefined;
1049
+ /** Data element ID "NAD". Middle Name(s) or Initial(s) of the Owner. Hyphenated names acceptable, spaces, between names acceptable, but no other use of special symbols. */
1050
+ get firstOwnerMiddleName(): Field | undefined;
1051
+ /** Data element ID "NAC". First Name or Given Name of the Owner. Hyphenated names acceptable, but no other use of special symbols. */
1052
+ get firstOwnerName(): Field | undefined;
1053
+ /** Data element ID "NAA". Name of the (or one of the) individual(s) who owns the Vehicle as defined in the ANSI D- 20 Data Element Dictionary. (Lastname@Firstname@MI@Suffix if any.) */
1054
+ get firstOwnerTotalName(): Field | undefined;
1055
+ /** Data element ID "NAR". Street address line 1. (Mailing) */
1056
+ get mailingAddress1(): Field | undefined;
1057
+ /** Data element ID "NAS". Street address line 2. (Mailing) */
1058
+ get mailingAddress2(): Field | undefined;
1059
+ /** Data element ID "NAT". Name of city for mailing address. */
1060
+ get mailingCity(): Field | undefined;
1061
+ /** Data element ID "NAU". Jurisdiction code for mailing address. Conforms to Canadian, Mexican and US jurisdictions as appropriate. Codes for provinces (Canada) and states (US and Mexico). */
1062
+ get mailingJurisdictionCode(): Field | undefined;
1063
+ /** Data element ID "NAV". The ZIP code or Postal code used for mailing. (As used by Canadian, Mexican and US jurisdictions.) */
1064
+ get mailingZipCode(): Field | undefined;
1065
+ /** Data element ID "NAM". Street address line 1. (Mailing) */
1066
+ get residenceAddress1(): Field | undefined;
1067
+ /** Data element ID "NAN". Street address line 2. (Mailing) */
1068
+ get residenceAddress2(): Field | undefined;
1069
+ /** Data element ID "NAO". Name of city for mailing address. */
1070
+ get residenceCity(): Field | undefined;
1071
+ /** Data element ID "NAP". Jurisdiction code for mailing address. Conforms to Canadian, Mexican and US jurisdictions as appropriate. Codes for provinces (Canada) and states (US and Mexico). */
1072
+ get residenceJurisdictionCode(): Field | undefined;
1073
+ /** Data element ID "NAQ". The ZIP code or Postal code used for mailing. (As used by Canadian, Mexican and US jurisdictions). */
1074
+ get residenceZipCode(): Field | undefined;
1075
+ /** Data element ID "NAY". The unique customer number/ID of the second vehicle owner. */
1076
+ get secondOwnerIdNumber(): Field | undefined;
1077
+ /** Data element ID "NAF". Last Name or Surname of the Owner. Hyphenated names acceptable, spaces between names acceptable, but no other use of special symbols. */
1078
+ get secondOwnerLastName(): Field | undefined;
1079
+ /** Data element ID "NBB". The legal status of the second vehicle owner. This is only used when a vehicle has multiple owners. A legal status may be ("AND", "OR"). */
1080
+ get secondOwnerLegalStatus(): Field | undefined;
1081
+ /** Data element ID "NAH". Middle Name(s) or Initial(s) of the Owner. Hyphenated names acceptable, spaces between names acceptable, but no other use of special symbols. */
1082
+ get secondOwnerMiddleName(): Field | undefined;
1083
+ /** Data element ID "NAG". First Name or Given Name of the Owner. Hyphenated names acceptable, but no other use of special symbols. */
1084
+ get secondOwnerName(): Field | undefined;
1085
+ /** Data element ID "NAE". Name of the (or one of the) individual(s) who owns the Vehicle as defined in the ANSI D- 20 Data Element Dictionary. (Lastname@Firstname@MI@Suffix if any.) */
1086
+ get secondOwnerTotalName(): Field | undefined;
1087
+ }
1088
+ /** Vehicle Data. File type "VH". */
1089
+ class VehicleData {
1090
+ private _document;
1091
+ get document(): GenericDocument;
1092
+ constructor(document: GenericDocument);
1093
+ requiredDocumentType(): string;
1094
+ /** Data element ID "VAO". Vehicle manufacture body style. */
1095
+ get bodyStyle(): Field | undefined;
1096
+ /** Data element ID "VAG". Date vehicle reported junked. The format is ISO8601 with delimiters. */
1097
+ get dateJunked(): Field | undefined;
1098
+ /** Data element ID "VAJ". Date vehicle reported recovered. The format is ISO8601 with delimiters. */
1099
+ get dateRecovered(): Field | undefined;
1100
+ /** Data element ID "VAI". Date vehicle reported stolen. The format is ISO8601 with delimiters. */
1101
+ get dateStolen(): Field | undefined;
1102
+ /** Data element ID "VAW". Manufacturer’s rated engine displacement. */
1103
+ get engineDisplacement(): Field | undefined;
1104
+ /** Data element ID "VAR". The size of a vehicle’s engine. */
1105
+ get engineSize(): Field | undefined;
1106
+ /** Data element ID "VAN". Type of fuel the vehicle utilizes. */
1107
+ get fuelType(): Field | undefined;
1108
+ /** Data element ID "VAU". Manufacturer’s rated horsepower. */
1109
+ get horsepower(): Field | undefined;
1110
+ /** Data element ID "VAY". International fuel tax indicator */
1111
+ get iftaIndicator(): Field | undefined;
1112
+ /** Data element ID "VAX". International registration plan indicator. */
1113
+ get irpIndicator(): Field | undefined;
1114
+ /** Data element ID "VAF". Vehicle has been junked. */
1115
+ get junkedIndicator(): Field | undefined;
1116
+ /** Data element ID "VAE". Manufacturer’s Suggested Retail Price. No decimal places. Right Justified Zero or space fill. */
1117
+ get msrp(): Field | undefined;
1118
+ /** Data element ID "VAA". State to provide definition. */
1119
+ get majorCode(): Field | undefined;
1120
+ /** Data element ID "VAL". Vehicle manufacture year. */
1121
+ get makeYear(): Field | undefined;
1122
+ /** Data element ID "VAT". Manufacturer’s gross vehicle weight rating. */
1123
+ get manufactureGrossWeight(): Field | undefined;
1124
+ /** Data element ID "VAB". State to provide definition. */
1125
+ get minorCode(): Field | undefined;
1126
+ /** Data element ID "VBC". Number of axles the vehicle has. */
1127
+ get numberOfAxles(): Field | undefined;
1128
+ /** Data element ID "VAQ". Number of cylinders the vehicle has. */
1129
+ get numberOfCylinders(): Field | undefined;
1130
+ /** Data element ID "VAP". Number of doors on the vehicle. */
1131
+ get numberOfDoors(): Field | undefined;
1132
+ /** Data element ID "VAH". Indicates stolen vehicle. */
1133
+ get stolenIndicator(): Field | undefined;
1134
+ /** Data element ID "VAC". Type of transmission the vehicle carries. */
1135
+ get transmissionCode(): Field | undefined;
1136
+ /** Data element ID "VAV". Gross weight of the vehicle unloaded. */
1137
+ get unladenWeight(): Field | undefined;
1138
+ /** Data element ID "VAZ". Vehicle license tax calculation from date of purchase. */
1139
+ get vltClacFromDate(): Field | undefined;
1140
+ /** Data element ID "VBA". Unique number to identify the vehicle record. */
1141
+ get vehicleIdNumber(): Field | undefined;
1142
+ /** Data element ID "VAD". A unique combination of alphanumeric characters that identifies a specific vehicle or component. The VIN is affixed to the vehicle in specific locations and formulated by the manufacturer. State agencies under some controlled instances may assign a VIN to a vehicle. */
1143
+ get vehicleIdentificationNumber(): Field | undefined;
1144
+ /** Data element ID "VAK". The distinctive (coded) name applied to a group of vehicles by a manufacturer. */
1145
+ get vehicleMake(): Field | undefined;
1146
+ /** Data element ID "VAM". Vehicle manufacture model. */
1147
+ get vehicleModel(): Field | undefined;
1148
+ /** Data element ID "VAS". This is the status of the vehicle (e.g., active, suspend, etc.) */
1149
+ get vehicleStatusCode(): Field | undefined;
1150
+ /** Data element ID "VBB". EPA vehicle classification. */
1151
+ get vehicleTypeCode(): Field | undefined;
1152
+ }
1153
+ /** Vehicle Safety Inspection Data. File type "VS". */
1154
+ class VehicleSafetyInspectionData {
1155
+ private _document;
1156
+ get document(): GenericDocument;
1157
+ constructor(document: GenericDocument);
1158
+ requiredDocumentType(): string;
1159
+ /** Data element ID "IAN". The street name and number, city, state and zip code of the inspection facility. */
1160
+ get inspectionAddress(): Field | undefined;
1161
+ /** Data element ID "IPD". Identifies whether the pollution control devices meet the minimum inspection criteria. */
1162
+ get inspectionAirPollutionDeviceConditions(): Field | undefined;
1163
+ /** Data element ID "IFI". The unique number assigned to an inspection facility. */
1164
+ get inspectionFacilityIdentifier(): Field | undefined;
1165
+ /** Data element ID "INC". A unique number assigned to a current vehicle inspection form for identification purposes or a preprinted unique number on the motor vehicle inspection sticker currently issued to a motor vehicle which has passed inspection. */
1166
+ get inspectionFormOrStickerNumberCurrent(): Field | undefined;
1167
+ /** Data element ID "INP". The number of the last inspection form excluding the current inspection or the certification number of the last inspection sticker, excluding the current inspection. */
1168
+ get inspectionFormOrStickerNumberPrevious(): Field | undefined;
1169
+ /** Data element ID "ISC". An indicator that specifies whether or not the vehicle has a current smog certificate. */
1170
+ get inspectionSmogCertificateIndicator(): Field | undefined;
1171
+ /** Data element ID "ISN". Station number performing the inspection. */
1172
+ get inspectionStationNumber(): Field | undefined;
1173
+ /** Data element ID "IIN". A unique number assigned to each licensed vehicle inspector. */
1174
+ get inspectorIdentificationNumber(): Field | undefined;
1175
+ /** Data element ID "ORI". The vehicle’s odometer reading (to the nearest mile or kilometer) at the time of inspection. */
1176
+ get odometerReadingAtInspection(): Field | undefined;
1177
+ /** Data element ID "VAO". The general configuration or shape of a vehicle distinguished by characteristics such as number of doors, seats, windows, roofline, and type of top. The vehicle body type is 2- character alphanumeric. */
1178
+ get vehicleBodyType(): Field | undefined;
1179
+ /** Data element ID "VAK". The distinctive (coded) name applied to a group of vehicles by a manufacturer. */
1180
+ get vehicleMake(): Field | undefined;
1181
+ /** Data element ID "VAL". The year which is assigned to a vehicle by the manufacturer. The format is CCYY. */
1182
+ get vehicleModelYear(): Field | undefined;
1183
+ }
1184
+ /** Driver License Or ID Document */
1185
+ abstract class DLID {
1186
+ private _document;
1187
+ get document(): GenericDocument;
1188
+ constructor(document: GenericDocument);
1189
+ abstract requiredDocumentType(): string;
1190
+ /** Data element ID "DAI". City portion of the cardholder address. */
1191
+ get addressCity(): Field | undefined;
1192
+ /** Data element ID "DAJ". State portion of the cardholder address. */
1193
+ get addressJurisdictionCode(): Field | undefined;
1194
+ /** Data element ID "DAK". Postal code portion of the cardholder address in the U.S. and Canada. If the trailing portion of the postal code in the U.S. is not known, zeros will be used to fill the trailing set of numbers up to nine (9) digits. */
1195
+ get addressPostalCode(): Field | undefined;
1196
+ /** Data element ID "DAG". Street portion of the cardholder address. */
1197
+ get addressStreet1(): Field | undefined;
1198
+ /** Data element ID "DAH". Second line of street portion of the cardholder address. */
1199
+ get addressStreet2(): Field | undefined;
1200
+ /** Data element ID "DCJ". A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If audit information is not used on the card or the MRT, it must be included in the driver record. */
1201
+ get adultInformation(): Field | undefined;
1202
+ /** Data element ID "DBN". Other family name by which cardholder is known. */
1203
+ get aliasFamilyName(): Field | undefined;
1204
+ /** Data element ID "DBG". Other given name by which cardholder is known. */
1205
+ get aliasGivenName(): Field | undefined;
1206
+ /** Data element ID "DBQ". Other middle name by which cardholder is known. */
1207
+ get aliasMiddleName(): Field | undefined;
1208
+ /** Data element ID "DBR". Other prefix by which cardholder is known. */
1209
+ get aliasPrefixName(): Field | undefined;
1210
+ /** Data element ID "DBS". Other suffix by which cardholder is known. */
1211
+ get aliasSuffixName(): Field | undefined;
1212
+ /** Data element ID "DDB". DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID. The format is ISO8601 with delimiters. */
1213
+ get cardRevisionDate(): Field | undefined;
1214
+ /** Data element ID "DDA". DHS required field that indicates compliance: "F" = compliant; and, "N" = non-compliant. */
1215
+ get complianceType(): Field | undefined;
1216
+ /** Data element ID "DCG". Country in which DL/ID is issued. U.S. = USA, Canada = CAN. */
1217
+ get countryIdentification(): Field | undefined;
1218
+ /** Data element ID "DCS". Family name of the cardholder. (Family name is sometimes also called “last name” or “surname.”) Collect full name for record, print as many characters as possible on portrait side of DL/ID. */
1219
+ get customerFamilyName(): Field | undefined;
1220
+ /** Data element ID "DAC". First name of the cardholder. */
1221
+ get customerFirstName(): Field | undefined;
1222
+ /** Data element ID "DCT". Given names of the cardholder. (Given names include all names other than the Family Name. This includes all those names sometimes also called “first” and “middle” names.) */
1223
+ get customerGivenNames(): Field | undefined;
1224
+ /** Data element ID "DAQ". The number assigned or calculated by the issuing authority. */
1225
+ get customerIdNumber(): Field | undefined;
1226
+ /** Data element ID "DAD". Middle name(s) of the cardholder. In the case of multiple middle names they shall be separated by a comma “,”. */
1227
+ get customerMiddleName(): Field | undefined;
1228
+ /** Data element ID "DBB". Date on which the cardholder was born. The format is ISO8601 with delimiters. */
1229
+ get dateOfBirth(): Field | undefined;
1230
+ /** Data element ID "DCF". Number must uniquely identify a particular document issued to that customer from others that may have been issued in the past. This number may serve multiple purposes of document discrimination, audit information number, and/or inventory control. */
1231
+ get documentDiscriminator(): Field | undefined;
1232
+ /** Data element ID "DBA". Date on which the driving and identification privileges granted by the document are no longer valid. The format is ISO8601 with delimtiers. */
1233
+ get documentExpirationDate(): Field | undefined;
1234
+ /** Data element ID "DBD". Date on which the document was issued. The format is ISO8601 with delimiters. */
1235
+ get documentIssueDate(): Field | undefined;
1236
+ /** Data element ID "DBL". Alternative dates given as date of birth. */
1237
+ get driverAliasDateOfBirthField(): Field | undefined;
1238
+ /** Data element ID "DBP". Alternative fist name or given name of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols. */
1239
+ get driverAliasFirstName(): Field | undefined;
1240
+ /** Data element ID "DBO". Alternative last name or surname of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols. */
1241
+ get driverAliasLastName(): Field | undefined;
1242
+ /** Data element ID "DBM". DriverAliasSocialSecurityNumber */
1243
+ get driverAliasSocialSecurityNumber(): Field | undefined;
1244
+ /** Data element ID "DAB". Last name or surname of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols. */
1245
+ get driverLastName(): Field | undefined;
1246
+ /** Data element ID "DAR". A=Class A; B=Class B; C=Class C (Class A, B and C are defined by Federal Highway regulations); M=Class M motorcycle as defined by AAMVA; others are defined by DL Classification Code Standards. */
1247
+ get driverLicenseClassificationCode(): Field | undefined;
1248
+ /** Data element ID "DAT". Any endorsements on a driver license which authorize the operation of specified types of vehicles or the operation of vehicles carrying specified loads. Endorsements shall be specific to classification of a driver license. */
1249
+ get driverLicenseEndorsementsCode(): Field | undefined;
1250
+ /** Data element ID "DAA". Name of the individual holding the Driver License or ID as defined in ANSI D20 Data Dictionary. (Lastname@Firstname@MI@ suffix if any) (Machine, Mag Stripe uses ‘$’ and Bar Code uses ‘,’ in place of ‘@’) Firstname, Middle Initial, Lastname (Human) */
1251
+ get driverLicenseName(): Field | undefined;
1252
+ /** Data element ID "DAS". A restriction applicable to a driver license. */
1253
+ get driverLicenseRestrictionCode(): Field | undefined;
1254
+ /** Data element ID "DAF". Prefix to Driver Name. Not defined in ANSI D20. Freeform as defined by issuing jurisdiction. */
1255
+ get driverNamePrefix(): Field | undefined;
1256
+ /** Data element ID "DAE". An affix occurring at the end of a word, e.g.; Sr., Jr., II, III, IV, etc. */
1257
+ get driverNameSuffix(): Field | undefined;
1258
+ /** Data element ID "PAA". Identifies the type of permit as defined by ANSI D20. */
1259
+ get driverPermitClassificationCode(): Field | undefined;
1260
+ /** Data element ID "PAF". Permit endorsements as defined by ANSI D20. */
1261
+ get driverPermitEndorsementCode(): Field | undefined;
1262
+ /** Data element ID "PAD". Date permit was issued. The format is ISO8601 with delimiters. */
1263
+ get driverPermitIssueDate(): Field | undefined;
1264
+ /** Data element ID "PAE". Permit restrictions as defined by ANSI D20. */
1265
+ get driverPermitRestrictionCode(): Field | undefined;
1266
+ /** Data element ID "DAN". Name of city for mailing address. */
1267
+ get driverResidenceCity(): Field | undefined;
1268
+ /** Data element ID "DAO". Jurisdiction code for mailing address. Conforms to Canadian, Mexican and US Jurisdictions as appropriate. Codes for provinces (Canada) and states (US and Mexico). */
1269
+ get driverResidenceJurisdictionCode(): Field | undefined;
1270
+ /** Data element ID "DAP". Postal code of residence */
1271
+ get driverResidencePostalCode(): Field | undefined;
1272
+ /** Data element ID "DAL". Street address line 1 (mailing). */
1273
+ get driverResidenceStreetAddress1(): Field | undefined;
1274
+ /** Data element ID "DAM". Street address line 2 (mailing). */
1275
+ get driverResidenceStreetAddress2(): Field | undefined;
1276
+ /** Data element ID "DDE". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U). */
1277
+ get familyNameTruncation(): Field | undefined;
1278
+ /** Data element ID "DCH". Federal Commercial Vehicle Codes */
1279
+ get federalCommercialVehicleCodes(): Field | undefined;
1280
+ /** Data element ID "DDF". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U). */
1281
+ get firstNameTruncation(): Field | undefined;
1282
+ /** Data element ID "DDC". Date on which the hazardous material endorsement granted by the document is no longer valid. The format is ISO8601 with delimiters. */
1283
+ get hazmatEndorsementExpirationDate(): Field | undefined;
1284
+ /** Data element ID "DAZ". Color of cardholder's hair. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary. */
1285
+ get hairColor(): Field | undefined;
1286
+ /** Data element ID "DAV". Height in centimeters */
1287
+ get height(): Field | undefined;
1288
+ /** Data element ID "DCK". A string of letters and/or numbers that is affixed to the raw materials (card stock, laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field). */
1289
+ get inventoryControlNumber(): Field | undefined;
1290
+ /** Data element ID "DBE". A string used by some jurisdictions to validate the document against their data base. */
1291
+ get issueTimeStamp(): Field | undefined;
1292
+ /** Data element ID "DCQ". Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class. */
1293
+ get jurisdictionSpecificEndorsementCodeDescription(): Field | undefined;
1294
+ /** Data element ID "DCD". Jurisdiction-specific codes that represent additional privileges granted to the cardholder beyond the vehicle class (such as transportation of passengers, hazardous materials, operation of motorcycles, etc.). */
1295
+ get jurisdictionSpecificEndorsementCodes(): Field | undefined;
1296
+ /** Data element ID "DCR". Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges. */
1297
+ get jurisdictionSpecificRestrictionCodeDescription(): Field | undefined;
1298
+ /** Data element ID "DCB". Jurisdiction-specific codes that represent restrictions to driving privileges (such as airbrakes, automatic transmission, daylight only, etc.). */
1299
+ get jurisdictionSpecificRestrictionCodes(): Field | undefined;
1300
+ /** Data element ID "DCA". Jurisdiction-specific vehicle class / group code, designating the type of vehicle the cardholder has privilege to drive. */
1301
+ get jurisdictionSpecificVehicleClass(): Field | undefined;
1302
+ /** Data element ID "DCP". Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive. */
1303
+ get jurisdictionSpecificVehicleClassificationDescription(): Field | undefined;
1304
+ /** Data element ID "DDD". DHS required field that indicates that the cardholder has temporary lawful status = "1". */
1305
+ get limitedDurationDocumentIndicator(): Field | undefined;
1306
+ /** Data element ID "DDG". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U). */
1307
+ get middleNameTruncation(): Field | undefined;
1308
+ /** Data element ID "DCU". Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID and in the MRT). Collect full name for record, print as many characters as possible on portrait side of DL/ID. JR (Junior), SR (Senior), 1ST or I (First), 2ND or II (Second), 3RD or III (Third), 4TH or IV (Fourth), 5TH or V (Fifth), 6TH or VI (Sixth), 7TH or VII (Seventh), 8TH or VIII (Eighth), 9TH or IX (Ninth). */
1309
+ get nameSuffix(): Field | undefined;
1310
+ /** Data element ID "DBI". "Y"; Used by some jurisdictions to indicate holder of the document is a non-resident. */
1311
+ get nonResidentIndicator(): Field | undefined;
1312
+ /** Data element ID "DBF". Number of duplicate cards issued for a license or ID if any. */
1313
+ get numberOfDuplicates(): Field | undefined;
1314
+ /** Data element ID "DBH". Organ Donor */
1315
+ get organDonor(): Field | undefined;
1316
+ /** Data element ID "DDK". Field that indicates that the cardholder is an organ donor = "1". */
1317
+ get organDonorIndicator(): Field | undefined;
1318
+ /** Data element ID "PAB". Date permit expires, The format is ISO8601 with delimiters. */
1319
+ get permitExpirationDate(): Field | undefined;
1320
+ /** Data element ID "PAC". Type of permit. */
1321
+ get permitIdentifier(): Field | undefined;
1322
+ /** Data element ID "DAY". Color of cardholder's eyes. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary. */
1323
+ get physicalDescriptionEyeColor(): Field | undefined;
1324
+ /** Data element ID "DAU". Height of cardholder. Inches (in): number of inches followed by " in" or Centimeters (cm): number of centimeters followed by " cm." */
1325
+ get physicalDescriptionHeight(): Field | undefined;
1326
+ /** Data element ID "DBC". Gender of the cardholder. "Male" or "Female". */
1327
+ get physicalDescriptionSex(): Field | undefined;
1328
+ /** Data element ID "DCE". Indicates the approximate weight range of the cardholder: 0 = up to 31 kg (up to 70 lbs), 1 = 32 – 45 kg (71 – 100 lbs), 2 = 46 - 59 kg (101 – 130 lbs), 3 = 60 - 70 kg (131 – 160 lbs), 4 = 71 - 86 kg (161 – 190 lbs), 5 = 87 - 100 kg (191 – 220 lbs), 6 = 101 - 113 kg (221 – 250 lbs), 7 = 114 - 127 kg (251 – 280 lbs), 8 = 128 – 145 kg (281 – 320 lbs), 9 = 146+ kg (321+ lbs). */
1329
+ get physicalDescriptionWeightRange(): Field | undefined;
1330
+ /** Data element ID "DCI". Country and municipality and/or state/province. */
1331
+ get placeOfBirth(): Field | undefined;
1332
+ /** Data element ID "DCL". Codes for race or ethnicity of the cardholder. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary. */
1333
+ get raceEthnicity(): Field | undefined;
1334
+ /** Data element ID "DBK". The number assigned to an individual by the Social Security Administration. */
1335
+ get socialSecurityNumber(): Field | undefined;
1336
+ /** Data element ID "DCN". Standard endorsement code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize endorsement codes. */
1337
+ get standardEndorsementCode(): Field | undefined;
1338
+ /** Data element ID "DCO". Standard restriction code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize restriction codes. */
1339
+ get standardRestrictionCode(): Field | undefined;
1340
+ /** Data element ID "DCM". Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications. */
1341
+ get standardVehicleClassification(): Field | undefined;
1342
+ /** Data element ID "DDH". Date on which the cardholder turns 18 years old. The format is ISO8601 with delimiters. */
1343
+ get under18Until(): Field | undefined;
1344
+ /** Data element ID "DDI". Date on which the cardholder turns 19 years old. The format is ISO8601 with delimiters. */
1345
+ get under19Until(): Field | undefined;
1346
+ /** Data element ID "DDJ". Date on which the cardholder turns 21 years old. The format is ISO8601 with delimiters. */
1347
+ get under21Until(): Field | undefined;
1348
+ /** Data element ID "DBJ". A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases. */
1349
+ get uniqueCustomerIdentifier(): Field | undefined;
1350
+ /** Data element ID "DDL". Field that indicates that the cardholder is a veteran = "1". */
1351
+ get veteranIndicator(): Field | undefined;
1352
+ /** Data element ID "DAX". Cardholder weight in kilograms Ex. 84 kg = "084" */
1353
+ get weightKilograms(): Field | undefined;
1354
+ /** Data element ID "DAW". Cardholder weight in pounds Ex. 185 lb = "185" */
1355
+ get weightPounds(): Field | undefined;
1356
+ }
1357
+ /** Driver License. File type "DL". */
1358
+ class DriverLicense extends DLID {
1359
+ constructor(document: GenericDocument);
1360
+ requiredDocumentType(): string;
1361
+ }
1362
+ /** ID Card. File type "ID". */
1363
+ class IDCard extends DLID {
1364
+ constructor(document: GenericDocument);
1365
+ requiredDocumentType(): string;
1366
+ }
1367
+ /** Enhanced Driver License. File type "EN". */
1368
+ class EnhancedDriverLicense extends DLID {
1369
+ constructor(document: GenericDocument);
1370
+ requiredDocumentType(): string;
1371
+ }
1372
+ /** The raw document as was parsed from the barcode. The original field key names and field values as they appear in the barcode are left as-is. The mnemonic field keys from the AAMVA specification are not replaced with human-readable names. No field value normalization, like ISO 8601 date reformatting, etc., is done. */
1373
+ class RawDocument {
1374
+ private _document;
1375
+ get document(): GenericDocument;
1376
+ constructor(document: GenericDocument);
1377
+ requiredDocumentType(): string;
1378
+ }
1379
+ }
1380
+ /** HIBC */
1381
+ export declare class HIBC {
1382
+ private _document;
1383
+ get document(): GenericDocument;
1384
+ constructor(document: GenericDocument);
1385
+ requiredDocumentType(): string;
1386
+ /** Date of Manufacture */
1387
+ get dateOfManufacture(): Field | undefined;
1388
+ /** Expiry Date Day */
1389
+ get expiryDateDay(): Field | undefined;
1390
+ /** Expiry Date Hour */
1391
+ get expiryDateHour(): Field | undefined;
1392
+ /** Expiry Date Julian Day */
1393
+ get expiryDateJulianDay(): Field | undefined;
1394
+ /** Expiry Date Month */
1395
+ get expiryDateMonth(): Field | undefined;
1396
+ /** Expiry Date Year */
1397
+ get expiryDateYear(): Field | undefined;
1398
+ /** Information whether primary data is present. */
1399
+ get hasPrimaryData(): Field;
1400
+ /** Information whether secondary data is present. */
1401
+ get hasSecondaryData(): Field;
1402
+ /** Labeler Identification Code (LIC) */
1403
+ get labelerIdentificationCode(): Field;
1404
+ /** Labelers Product or Catalog Number (PCN). Alphanumeric data. */
1405
+ get labelersProductOrCatalogNumber(): Field;
1406
+ /** Link character to link standalone primary and secondary barcodes together. */
1407
+ get linkCharacter(): Field | undefined;
1408
+ /** Lot Number */
1409
+ get lotNumber(): Field | undefined;
1410
+ /** Quantity */
1411
+ get quantity(): Field | undefined;
1412
+ /** Serial Number */
1413
+ get serialNumber(): Field | undefined;
1414
+ /** Unit of Measure ID, Numeric value only, 0 through 9, where 0 always represents
1415
+ a single unit. 1 to 8 are used to indicate different packaging levels above the unit of use.
1416
+ The value 9 is used for variable quantity containers when manual key entry or scan of
1417
+ a secondary will be used to collect specific quantity data.
1418
+ The labeler should ensure consistency in this field within their packaging process.
1419
+ */
1420
+ get unitOfMeasureID(): Field;
1421
+ }