@dvsa/cvs-type-definitions 6.3.0 → 7.0.0

package/types/v1/vehicle/index.d.ts

@@ -5,6 +5,9 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
+export type InspectionType = "basic" | "normal";
+
 export interface VehicleSchema {
   systemNumber: string;
   vrm: string;
@@ -220,15 +223,15 @@ export interface TankStatementSchema {
 }
 export interface TestResultSchema {
   testResultId: string;
-  testStationName: string;
-  testStationPNumber: string;
-  testStationType: string;
-  testerName: string;
+  testStationName: string | null;
+  testStationPNumber: string | null;
+  testStationType: TestStationTypes;
+  testerName: string | null;
   testerStaffId: string;
-  testerEmailAddress: string;
+  testerEmailAddress: string | null;
   testStartTimestamp: string;
   testEndTimestamp: string;
-  testStatus: string;
+  testStatus: TestStatus;
   reasonForCancellation: string | null;
   systemNumber: string;
   vrm?: string;
@@ -236,31 +239,51 @@ export interface TestResultSchema {
   vin: string;
   vehicleClass: VehicleClassSchema;
   vehicleSubclass?: string[];
-  vehicleType: string;
+  vehicleType: VehicleType;
   vehicleConfiguration: string;
   odometerReading?: number | null;
-  odometerReadingUnits?: string | null;
-  preparerId: string;
-  preparerName: string;
-  euVehicleCategory: string;
+  odometerReadingUnits?: OdometerReadingUnits | null;
+  preparerId: string | null;
+  preparerName: string | null;
+  euVehicleCategory: EUVehicleCategory;
   countryOfRegistration: string | null;
   noOfAxles: number;
-  numberOfWheelsDriven: number;
+  numberOfWheelsDriven: number | null;
   vehicleSize?: string;
   numberOfSeats?: number;
-  regnDate?: string;
-  firstUseDate?: string;
+  regnDate?: string | null;
+  firstUseDate?: string | null;
   testTypes: TestTypeSchema[];
+  reasonForCreation?: string;
+  createdAt?: string | null;
+  createdByEmailAddress?: string;
+  createdByName?: string;
+  createdById?: string;
+  lastUpdatedAt?: string | null;
+  lastUpdatedByEmailAddress?: string;
+  lastUpdatedByName?: string;
+  lastUpdatedById?: string;
+  shouldEmailCertificate?: string;
+  contingencyTestNumber?: string | null;
+  typeOfTest?: TypeOfTest;
+  source?: TestSources;
+  make?: string | null;
+  model?: string | null;
+  bodyType?: BodyTypeSchema;
 }
 export interface TestTypeSchema {
-  testTypeName: string;
+  testTypeName: string | null;
   name: string;
   testTypeId: string;
   certificateNumber: string | null;
   secondaryCertificateNumber: string | null;
   testTypeStartTimestamp: string | null;
   testTypeEndTimestamp: string | null;
-  testResult: string | null;
+  testResult:
+    | {
+        [k: string]: unknown;
+      }
+    | TestResults;
   prohibitionIssued: boolean | null;
   reasonForAbandoning: string | null;
   additionalNotesRecorded: string | null;
@@ -269,20 +292,27 @@ export interface TestTypeSchema {
   lastSeatbeltInstallationCheckDate?: string | null;
   seatbeltInstallationCheckDate?: boolean | null;
   testExpiryDate?: string;
+  testAnniversaryDate?: string | null;
   modType?: ModTypeSchema | string | null;
-  emissionStandard?: string;
-  fuelType?: string;
-  modificationTypeUsed?: string;
-  smokeTestKLimitApplied?: string;
-  particulateTrapFitted?: string;
-  particulateTrapSerialNumber?: string;
+  emissionStandard?:
+    | {
+        [k: string]: unknown;
+      }
+    | EmissionStandards;
+  fuelType?:
+    | {
+        [k: string]: unknown;
+      }
+    | FuelType;
+  modificationTypeUsed?: string | null;
+  smokeTestKLimitApplied?: string | null;
+  particulateTrapFitted?: string | null;
+  particulateTrapSerialNumber?: string | null;
   defects: DefectDetailsSchema[];
-  customDefects?: SpecialistCustomDefectsSchema[];
-  completionStatus?: string;
-  testTypeCategoryName?: string;
-  reasons?: string[];
-  testNumber?: string;
-  linkedIds?: string[] | null;
+  customDefects?: SpecialistCustomDefectsSchema[] | null;
+  requiredStandards?: SpecialistCustomDefectsSchemaPut[];
+  testNumber?: string | null;
+  reapplicationDate?: string | null;
 }
 export interface ModTypeSchema {
   code: string;
@@ -343,3 +373,88 @@ export interface SpecialistCustomDefectsSchema {
    */
   hasAllMandatoryFields?: boolean;
 }
+export interface SpecialistCustomDefectsSchemaPut {
+  sectionNumber: string;
+  sectionDescription: string;
+  additionalNotes?: string | null;
+  rsNumber: number;
+  requiredStandard: string;
+  refCalculation: string;
+  additionalInfo: boolean;
+  inspectionTypes?: InspectionType[];
+  prs: boolean;
+}
+export interface BodyTypeSchema {
+  code?: string | null;
+  description?: string | null;
+}
+
+export enum TestStationTypes {
+  ATF = "atf",
+  GVTS = "gvts",
+  HQ = "hq",
+  POTF = "potf"
+}
+export enum TestStatus {
+  SUBMITTED = "submitted",
+  CANCELLED = "cancelled"
+}
+export enum OdometerReadingUnits {
+  KILOMETRES = "kilometres",
+  MILES = "miles"
+}
+export enum EUVehicleCategory {
+  M1 = "m1",
+  M2 = "m2",
+  M3 = "m3",
+  N1 = "n1",
+  N2 = "n2",
+  N3 = "n3",
+  O1 = "o1",
+  O2 = "o2",
+  O3 = "o3",
+  O4 = "o4",
+  L1E_A = "l1e-a",
+  l1E = "l1e",
+  L2e = "l2e",
+  L3E = "l3e",
+  L4E = "l4e",
+  L5E = "l5e",
+  L6E = "l6e",
+  L7E = "l7e"
+}
+export enum TestResults {
+  PASS = "pass",
+  PRS = "prs",
+  FAIL = "fail",
+  ABANDONED = "abandoned"
+}
+export enum EmissionStandards {
+  EURO3_PM = "0.10 g/kWh Euro 3 PM",
+  EURO4_PM = "0.03 g/kWh Euro IV PM'",
+  EURO3 = "Euro 3",
+  EURO4 = "Euro 4",
+  EURO5 = "Euro 5",
+  EURO6 = "Euro 6",
+  EUROV = "Euro V",
+  EUROVI = "Euro VI",
+  FULL_ELECTRIC = "Full Electric"
+}
+export enum FuelType {
+  DIESEL = "diesel",
+  GAS_CNG = "gas-cng",
+  GAS_LNG = "gas-lng",
+  GAS_LPG = "gas-lpg",
+  PETROL = "petrol",
+  FUEL_CELL = "fuel cell",
+  FULL_ELECTRIC = "full electric"
+}
+export enum TypeOfTest {
+  CONTINGENCY = "contingency",
+  DESK_BASED = "desk-based",
+  COMPLETION = "completion"
+}
+export enum TestSources {
+  VTM = "vtm",
+  VTA = "vta"
+}

package/types/v1/visit/index.d.ts

@@ -5,6 +5,9 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
+export type InspectionType = "basic" | "normal";
+
 export interface VisitSchema {
   startTime: string;
   endTime: string;
@@ -241,15 +244,15 @@ export interface TankStatementSchema {
 }
 export interface TestResultSchema {
   testResultId: string;
-  testStationName: string;
-  testStationPNumber: string;
-  testStationType: string;
-  testerName: string;
+  testStationName: string | null;
+  testStationPNumber: string | null;
+  testStationType: TestStationTypes;
+  testerName: string | null;
   testerStaffId: string;
-  testerEmailAddress: string;
+  testerEmailAddress: string | null;
   testStartTimestamp: string;
   testEndTimestamp: string;
-  testStatus: string;
+  testStatus: TestStatus;
   reasonForCancellation: string | null;
   systemNumber: string;
   vrm?: string;
@@ -257,31 +260,51 @@ export interface TestResultSchema {
   vin: string;
   vehicleClass: VehicleClassSchema;
   vehicleSubclass?: string[];
-  vehicleType: string;
+  vehicleType: VehicleType;
   vehicleConfiguration: string;
   odometerReading?: number | null;
-  odometerReadingUnits?: string | null;
-  preparerId: string;
-  preparerName: string;
-  euVehicleCategory: string;
+  odometerReadingUnits?: OdometerReadingUnits | null;
+  preparerId: string | null;
+  preparerName: string | null;
+  euVehicleCategory: EUVehicleCategory;
   countryOfRegistration: string | null;
   noOfAxles: number;
-  numberOfWheelsDriven: number;
+  numberOfWheelsDriven: number | null;
   vehicleSize?: string;
   numberOfSeats?: number;
-  regnDate?: string;
-  firstUseDate?: string;
+  regnDate?: string | null;
+  firstUseDate?: string | null;
   testTypes: TestTypeSchema[];
+  reasonForCreation?: string;
+  createdAt?: string | null;
+  createdByEmailAddress?: string;
+  createdByName?: string;
+  createdById?: string;
+  lastUpdatedAt?: string | null;
+  lastUpdatedByEmailAddress?: string;
+  lastUpdatedByName?: string;
+  lastUpdatedById?: string;
+  shouldEmailCertificate?: string;
+  contingencyTestNumber?: string | null;
+  typeOfTest?: TypeOfTest;
+  source?: TestSources;
+  make?: string | null;
+  model?: string | null;
+  bodyType?: BodyTypeSchema;
 }
 export interface TestTypeSchema {
-  testTypeName: string;
+  testTypeName: string | null;
   name: string;
   testTypeId: string;
   certificateNumber: string | null;
   secondaryCertificateNumber: string | null;
   testTypeStartTimestamp: string | null;
   testTypeEndTimestamp: string | null;
-  testResult: string | null;
+  testResult:
+    | {
+        [k: string]: unknown;
+      }
+    | TestResults;
   prohibitionIssued: boolean | null;
   reasonForAbandoning: string | null;
   additionalNotesRecorded: string | null;
@@ -290,20 +313,27 @@ export interface TestTypeSchema {
   lastSeatbeltInstallationCheckDate?: string | null;
   seatbeltInstallationCheckDate?: boolean | null;
   testExpiryDate?: string;
+  testAnniversaryDate?: string | null;
   modType?: ModTypeSchema | string | null;
-  emissionStandard?: string;
-  fuelType?: string;
-  modificationTypeUsed?: string;
-  smokeTestKLimitApplied?: string;
-  particulateTrapFitted?: string;
-  particulateTrapSerialNumber?: string;
+  emissionStandard?:
+    | {
+        [k: string]: unknown;
+      }
+    | EmissionStandards;
+  fuelType?:
+    | {
+        [k: string]: unknown;
+      }
+    | FuelType;
+  modificationTypeUsed?: string | null;
+  smokeTestKLimitApplied?: string | null;
+  particulateTrapFitted?: string | null;
+  particulateTrapSerialNumber?: string | null;
   defects: DefectDetailsSchema[];
-  customDefects?: SpecialistCustomDefectsSchema[];
-  completionStatus?: string;
-  testTypeCategoryName?: string;
-  reasons?: string[];
-  testNumber?: string;
-  linkedIds?: string[] | null;
+  customDefects?: SpecialistCustomDefectsSchema[] | null;
+  requiredStandards?: SpecialistCustomDefectsSchemaPut[];
+  testNumber?: string | null;
+  reapplicationDate?: string | null;
 }
 export interface ModTypeSchema {
   code: string;
@@ -364,3 +394,88 @@ export interface SpecialistCustomDefectsSchema {
    */
   hasAllMandatoryFields?: boolean;
 }
+export interface SpecialistCustomDefectsSchemaPut {
+  sectionNumber: string;
+  sectionDescription: string;
+  additionalNotes?: string | null;
+  rsNumber: number;
+  requiredStandard: string;
+  refCalculation: string;
+  additionalInfo: boolean;
+  inspectionTypes?: InspectionType[];
+  prs: boolean;
+}
+export interface BodyTypeSchema {
+  code?: string | null;
+  description?: string | null;
+}
+
+export enum TestStationTypes {
+  ATF = "atf",
+  GVTS = "gvts",
+  HQ = "hq",
+  POTF = "potf"
+}
+export enum TestStatus {
+  SUBMITTED = "submitted",
+  CANCELLED = "cancelled"
+}
+export enum OdometerReadingUnits {
+  KILOMETRES = "kilometres",
+  MILES = "miles"
+}
+export enum EUVehicleCategory {
+  M1 = "m1",
+  M2 = "m2",
+  M3 = "m3",
+  N1 = "n1",
+  N2 = "n2",
+  N3 = "n3",
+  O1 = "o1",
+  O2 = "o2",
+  O3 = "o3",
+  O4 = "o4",
+  L1E_A = "l1e-a",
+  l1E = "l1e",
+  L2e = "l2e",
+  L3E = "l3e",
+  L4E = "l4e",
+  L5E = "l5e",
+  L6E = "l6e",
+  L7E = "l7e"
+}
+export enum TestResults {
+  PASS = "pass",
+  PRS = "prs",
+  FAIL = "fail",
+  ABANDONED = "abandoned"
+}
+export enum EmissionStandards {
+  EURO3_PM = "0.10 g/kWh Euro 3 PM",
+  EURO4_PM = "0.03 g/kWh Euro IV PM'",
+  EURO3 = "Euro 3",
+  EURO4 = "Euro 4",
+  EURO5 = "Euro 5",
+  EURO6 = "Euro 6",
+  EUROV = "Euro V",
+  EUROVI = "Euro VI",
+  FULL_ELECTRIC = "Full Electric"
+}
+export enum FuelType {
+  DIESEL = "diesel",
+  GAS_CNG = "gas-cng",
+  GAS_LNG = "gas-lng",
+  GAS_LPG = "gas-lpg",
+  PETROL = "petrol",
+  FUEL_CELL = "fuel cell",
+  FULL_ELECTRIC = "full electric"
+}
+export enum TypeOfTest {
+  CONTINGENCY = "contingency",
+  DESK_BASED = "desk-based",
+  COMPLETION = "completion"
+}
+export enum TestSources {
+  VTM = "vtm",
+  VTA = "vta"
+}