@vulog/aima-vehicle 1.2.30 → 1.2.31

package/dist/index.d.mts

@@ -1,244 +1,212 @@
-import { Client } from '@vulog/aima-client';
-import { PaginableOptions, PaginableResponse } from '@vulog/aima-core';
+import { PaginableOptions, PaginableResponse } from "@vulog/aima-core";
+import { Client } from "@vulog/aima-client";
 
+//#region src/types.d.ts
 /**
  * Represents a vehicle model with its specifications and characteristics
  */
 type Model = {
-    /** Unique identifier of the model */
-    id: number;
-    /** Name of the model (e.g., "C-Zero") */
-    name: string;
-    /** Type of energy used by the vehicle (e.g., "ELECTRIC") */
-    energyType: string;
-    /** Current status of the model (e.g., "ACTIVE") */
-    status: string;
-    /** Number of seats in the vehicle */
-    nbOfSeats: number;
-    /** Maximum range/autonomy of the vehicle in kilometers */
-    autonomy: number;
-    /** Date when the model was created */
-    creationDate: string;
-    /** Date when the model was last updated */
-    updateDate: string;
-    /** Description of the model (e.g., brand name) */
-    description: string;
-    /** ID of the fleet this model belongs to */
-    fleetId: string;
-    /** Type of vehicle (e.g., "CAR") */
-    vehicleType: string;
-    /** Type of transmission (e.g., "UNDEFINED") */
-    transmission: string;
-    /** Range threshold for out of service status */
-    outOfServiceRange: string;
-    /** Range threshold for recovery */
-    recoveryRange: string;
-    /** Array of incentive thresholds */
-    incentiveThresholds: any[];
-    /** Range threshold for vehicle redistribution */
-    redistributeVehicleChargedEnoughRange: string;
-    /** Indicates if the odometer readings are reliable */
-    odometerReliable?: boolean;
-    [key: string]: any;
+  /** Unique identifier of the model */id: number; /** Name of the model (e.g., "C-Zero") */
+  name: string; /** Type of energy used by the vehicle (e.g., "ELECTRIC") */
+  energyType: string; /** Current status of the model (e.g., "ACTIVE") */
+  status: string; /** Number of seats in the vehicle */
+  nbOfSeats: number; /** Maximum range/autonomy of the vehicle in kilometers */
+  autonomy: number; /** Date when the model was created */
+  creationDate: string; /** Date when the model was last updated */
+  updateDate: string; /** Description of the model (e.g., brand name) */
+  description: string; /** ID of the fleet this model belongs to */
+  fleetId: string; /** Type of vehicle (e.g., "CAR") */
+  vehicleType: string; /** Type of transmission (e.g., "UNDEFINED") */
+  transmission: string; /** Range threshold for out of service status */
+  outOfServiceRange: string; /** Range threshold for recovery */
+  recoveryRange: string; /** Array of incentive thresholds */
+  incentiveThresholds: any[]; /** Range threshold for vehicle redistribution */
+  redistributeVehicleChargedEnoughRange: string; /** Indicates if the odometer readings are reliable */
+  odometerReliable?: boolean;
+  [key: string]: any;
 };
 /**
  * Represents a vehicle in the system
  */
 type Vehicle = {
-    /** Unique identifier of the vehicle */
-    id: string;
-    /** Name of the vehicle */
-    name: string;
-    /** License plate number */
-    plate: string;
-    /** Vehicle Identification Number */
-    vin: string;
-    /** Model information of the vehicle */
-    model: Model;
-    /** List of options/features installed on the vehicle */
-    options: Options[];
-    /** Date when the vehicle was created */
-    createDate: string;
-    /** Date when the vehicle was last updated */
-    updateDate: string;
-    /** ID of the fleet this vehicle belongs to */
-    fleetId: string;
-    /** External system identifier */
-    externalId: string;
-    /** Provider used for vehicle wakeup */
-    wakeupProvider?: string;
-    /** Mobile Subscriber Integrated Services Digital Network Number */
-    msisdn: string;
-    /** Integrated Circuit Card Identifier */
-    iccid: string;
-    /** International Mobile Subscriber Identity */
-    imsi?: string;
-    /** Whether the vehicle is published in the system */
-    published: boolean;
-    /** Whether the vehicle has no box installed */
-    noBox: boolean;
-    /** Whether the vehicle is archived */
-    archived: boolean;
-    [key: string]: any;
+  /** Unique identifier of the vehicle */id: string; /** Name of the vehicle */
+  name: string; /** License plate number */
+  plate: string; /** Vehicle Identification Number */
+  vin: string; /** Model information of the vehicle */
+  model: Model; /** List of options/features installed on the vehicle */
+  options: Options[]; /** Date when the vehicle was created */
+  createDate: string; /** Date when the vehicle was last updated */
+  updateDate: string; /** ID of the fleet this vehicle belongs to */
+  fleetId: string; /** External system identifier */
+  externalId: string; /** Provider used for vehicle wakeup */
+  wakeupProvider?: string; /** Mobile Subscriber Integrated Services Digital Network Number */
+  msisdn: string; /** Integrated Circuit Card Identifier */
+  iccid: string; /** International Mobile Subscriber Identity */
+  imsi?: string; /** Whether the vehicle is published in the system */
+  published: boolean; /** Whether the vehicle has no box installed */
+  noBox: boolean; /** Whether the vehicle is archived */
+  archived: boolean;
+  [key: string]: any;
 };
 /**
  * Represents a vehicle option or feature
  */
 type Options = {
-    /** Unique identifier of the option */
-    id: number;
-    /** ID of the fleet this option belongs to */
-    fleetId: string;
-    /** Name of the option */
-    name: string;
-    /** Type of the option (e.g., "Color", "Gearbox") */
-    type: string;
-    /** Description of the option */
-    description: string;
-    [key: string]: any;
+  /** Unique identifier of the option */id: number; /** ID of the fleet this option belongs to */
+  fleetId: string; /** Name of the option */
+  name: string; /** Type of the option (e.g., "Color", "Gearbox") */
+  type: string; /** Description of the option */
+  description: string;
+  [key: string]: any;
 };
 type Zone = {
-    type: string;
-    version: number;
-    zoneId: string;
-    sticky: boolean;
-    labels: {
-        labelId: string;
-        name: string;
-        publicName: string;
-    }[];
+  type: string;
+  version: number;
+  zoneId: string;
+  sticky: boolean;
+  labels: {
+    labelId: string;
+    name: string;
+    publicName: string;
+  }[];
 };
 type VehicleRealTime = {
-    id: string;
-    name: string;
-    plate: string;
-    vin: string;
-    fleetid: string;
-    currentFleetId: string;
-    ownerFleetId: string;
-    boxid: string;
-    vehicle_status: number;
-    zones: Zone[];
-    releasable: boolean;
-    box_status: number;
-    autonomy: number;
-    autonomy2: number;
-    isCharging: boolean;
-    battery: number;
-    km: number;
-    speed: number;
-    location: {
-        geohash: string;
-        cap: number;
-        latitude: number;
-        longitude: number;
-        gpsDate: string;
-        lastMovingDate: string;
-    };
-    endTripLocation: {
-        latitude: number;
-        longitude: number;
-    };
-    endZoneIds: [];
-    productIds: [];
-    isDoorClosed: boolean;
-    isDoorLocked: boolean;
-    engineOn: boolean;
-    immobilizerOn: boolean;
-    secureOn: boolean;
-    spareLockOn: boolean | null;
-    pileLockOn: boolean | null;
-    helmetPresent: boolean | null;
-    helmet2Present: boolean | null;
-    helmetBoxLockOn: boolean | null;
-    helmet2LockOn: boolean | null;
-    userId: string | null;
-    user_locale: string | null;
-    rfid: string | null;
-    orderId: string | null;
-    gatewayUrl: string | null;
-    booking_status: number;
-    booking_date: string | null;
-    expiresOn: boolean | null;
-    last_active_date: string;
-    last_wakeUp_date: string;
-    version: string;
-    pricingId: string | null;
-    start_date: string | null;
-    theorStartDate: string | null;
-    theorEndDate: string | null;
-    startZones: Zone[];
-    endZones: Zone[];
-    disabled: boolean;
-    outOfServiceReason: string;
-    ignitionOffGeohash: string | null;
-    geohashNeighbours: string[];
-    cleanlinessStatus: boolean;
-    needsRedistribution: boolean;
-    batteryUnderThreshold: boolean;
-    isBeingTowed: boolean;
-    automaticallyEnableVehicleAfterRangeRecovery: boolean;
-    key: {
-        deviceName: string;
-    };
-    doNotTrack: boolean;
-    energyLevel: number;
-    lastOosDate: string;
-    hasAlerts: boolean;
-    firmwareModel: string;
-    comeFromApp: string;
-    doors: {
-        frontLeftClosed: boolean;
-        frontRightClosed: boolean;
-        rearLeftClosed: boolean;
-        rearRightClosed: boolean;
-        trunkClosed: boolean;
-        hoodClosed: boolean;
-    };
-    windows: {
-        frontLeftClosed: boolean;
-        frontRightClosed: boolean;
-        rearLeftClosed: boolean;
-        rearRightClosed: boolean;
-        trunkClosed: boolean;
-    };
-    doorsAndWindowsClosed: boolean;
-    vpChecksum: string;
-    firmwareBuildDate: string;
-    [key: string]: any;
+  id: string;
+  name: string;
+  plate: string;
+  vin: string;
+  fleetid: string;
+  currentFleetId: string;
+  ownerFleetId: string;
+  boxid: string;
+  vehicle_status: number;
+  zones: Zone[];
+  releasable: boolean;
+  box_status: number;
+  autonomy: number;
+  autonomy2: number;
+  isCharging: boolean;
+  battery: number;
+  km: number;
+  speed: number;
+  location: {
+    geohash: string;
+    cap: number;
+    latitude: number;
+    longitude: number;
+    gpsDate: string;
+    lastMovingDate: string;
+  };
+  endTripLocation: {
+    latitude: number;
+    longitude: number;
+  };
+  endZoneIds: [];
+  productIds: [];
+  isDoorClosed: boolean;
+  isDoorLocked: boolean;
+  engineOn: boolean;
+  immobilizerOn: boolean;
+  secureOn: boolean;
+  spareLockOn: boolean | null;
+  pileLockOn: boolean | null;
+  helmetPresent: boolean | null;
+  helmet2Present: boolean | null;
+  helmetBoxLockOn: boolean | null;
+  helmet2LockOn: boolean | null;
+  userId: string | null;
+  user_locale: string | null;
+  rfid: string | null;
+  orderId: string | null;
+  gatewayUrl: string | null;
+  booking_status: number;
+  booking_date: string | null;
+  expiresOn: boolean | null;
+  last_active_date: string;
+  last_wakeUp_date: string;
+  version: string;
+  pricingId: string | null;
+  start_date: string | null;
+  theorStartDate: string | null;
+  theorEndDate: string | null;
+  startZones: Zone[];
+  endZones: Zone[];
+  disabled: boolean;
+  outOfServiceReason: string;
+  ignitionOffGeohash: string | null;
+  geohashNeighbours: string[];
+  cleanlinessStatus: boolean;
+  needsRedistribution: boolean;
+  batteryUnderThreshold: boolean;
+  isBeingTowed: boolean;
+  automaticallyEnableVehicleAfterRangeRecovery: boolean;
+  key: {
+    deviceName: string;
+  };
+  doNotTrack: boolean;
+  energyLevel: number;
+  lastOosDate: string;
+  hasAlerts: boolean;
+  firmwareModel: string;
+  comeFromApp: string;
+  doors: {
+    frontLeftClosed: boolean;
+    frontRightClosed: boolean;
+    rearLeftClosed: boolean;
+    rearRightClosed: boolean;
+    trunkClosed: boolean;
+    hoodClosed: boolean;
+  };
+  windows: {
+    frontLeftClosed: boolean;
+    frontRightClosed: boolean;
+    rearLeftClosed: boolean;
+    rearRightClosed: boolean;
+    trunkClosed: boolean;
+  };
+  doorsAndWindowsClosed: boolean;
+  vpChecksum: string;
+  firmwareBuildDate: string;
+  [key: string]: any;
 };
 type Assets = {
-    fleet_id: string;
-    model_id: number;
-    assets: {
-        aid: string;
-        type: string;
-        url: string | null;
-        value: number | null;
-        b_value: boolean | null;
-        text: string | null;
-        [key: string]: any;
-    }[];
+  fleet_id: string;
+  model_id: number;
+  assets: {
+    aid: string;
+    type: string;
+    url: string | null;
+    value: number | null;
+    b_value: boolean | null;
+    text: string | null;
     [key: string]: any;
+  }[];
+  [key: string]: any;
 };
 type ModelVehicle = {
-    serviceId: string;
-    serviceVisibility: 'PUBLIC' | 'PRIVATE';
-    modelId: number;
-    vehicles: string[];
+  serviceId: string;
+  serviceVisibility: 'PUBLIC' | 'PRIVATE';
+  modelId: number;
+  vehicles: string[];
 };
-
+//#endregion
+//#region src/getModel.d.ts
 declare const getModelsById: (client: Client, id: number) => Promise<Model>;
-
+//#endregion
+//#region src/getModelAssets.d.ts
 declare const getModelByIdAssets: (client: Client, id: number) => Promise<Assets>;
-
+//#endregion
+//#region src/getModels.d.ts
 declare const getModels: (client: Client) => Promise<Model[]>;
-
+//#endregion
+//#region src/getVehicle.d.ts
 declare const getVehicleById: (client: Client, id: string) => Promise<Vehicle | null>;
 declare const getVehicleRealTimeById: (client: Client, id: string) => Promise<VehicleRealTime | null>;
-
+//#endregion
+//#region src/getVehicleAssets.d.ts
 declare const getVehicleByIdAssets: (client: Client, id: string) => Promise<Assets>;
-
+//#endregion
+//#region src/getVehicles.d.ts
 /**
  * Fetches all vehicles from the API using pagination
  * @param client - The AIMA client instance
@@ -257,24 +225,49 @@ declare const getVehicles: (client: Client, pageSize?: number) => Promise<Vehicl
  * @throws Error if lastUpdatedMillis is in the future
  */
 declare const getVehiclesRealTime: (client: Client, pageSize?: number, lastUpdatedMillis?: number) => Promise<VehicleRealTime[]>;
-
+//#endregion
+//#region src/pingVehicle.d.ts
 /**
  * Pings a vehicle to check if it is alive (box connected).
  * Returns true if alive (HTTP 200), false if box not connected (code 410, codeStr 'carConnectionProblem'),
  * throws for other errors or invalid id.
  */
 declare const pingVehicleById: (client: Client, id: string) => Promise<boolean>;
-
+//#endregion
+//#region src/enableVehicle.d.ts
 type EnableVehicleBody = {
-    subStatus: string;
+  subStatus: string;
 };
 declare const enableVehicle: (client: Client, vehicleId: string, payload: EnableVehicleBody) => Promise<void>;
-
+//#endregion
+//#region src/disableVehicle.d.ts
 type DisableVehicleBody = {
-    subStatus: string;
+  subStatus: string;
 };
 declare const disableVehicle: (client: Client, vehicleId: string, payload: DisableVehicleBody) => Promise<void>;
-
+//#endregion
+//#region src/getModelVehicles.d.ts
 declare const getModelVehicles: (client: Client, options?: PaginableOptions) => Promise<PaginableResponse<ModelVehicle>>;
-
-export { type Assets, type DisableVehicleBody, type EnableVehicleBody, type Model, type ModelVehicle, type Options, type Vehicle, type VehicleRealTime, type Zone, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById };
+//#endregion
+//#region src/createVehicle.d.ts
+type CreateVehicleBody = {
+  vin: string;
+  plate: string;
+  name: string;
+  model: {
+    id: number;
+  };
+  vuboxId?: string;
+  externalId?: string;
+  wakeupProvider?: string;
+  noBox?: boolean;
+  published?: boolean;
+  archived?: boolean;
+  msisdn?: string;
+  iccid?: string;
+  imsi?: string;
+  residualValue?: number;
+};
+declare const createVehicle: (client: Client, body: CreateVehicleBody) => Promise<Vehicle>;
+//#endregion
+export { Assets, CreateVehicleBody, DisableVehicleBody, EnableVehicleBody, Model, ModelVehicle, Options, Vehicle, VehicleRealTime, Zone, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById };