@vulog/aima-event/dist/index.d.cts

Event tracking — query fleet events by type, trip, or time range.

import { Client } from "@vulog/aima-client";
import { PaginableOptions, PaginableResponse } from "@vulog/aima-core";
import { z } from "zod";

//#region src/types.d.ts
type ExtraInfo = {
  bookingId?: string;
  [key: string]: any;
};
type Event = {
  fleetId: string;
  userId: string;
  origin: string;
  type: string;
  date: string;
  failed: boolean;
  originId?: string;
  insertionDate?: string;
  deletionDate?: string;
  doNotTrack: boolean;
  extraInfo: ExtraInfo;
  [key: string]: any;
};
//#endregion
//#region src/getEvents.d.ts
declare const EventTypeList: z.ZodEnum<{
  USER_ACCOUNT_UPDATE: "USER_ACCOUNT_UPDATE";
  USER_CREATED: "USER_CREATED";
  USER_ARCHIVED: "USER_ARCHIVED";
  USER_INACTIVE: "USER_INACTIVE";
  USER_DELETED: "USER_DELETED";
  USER_RESET_PASSWORD: "USER_RESET_PASSWORD";
  USER_ROLE_ADD: "USER_ROLE_ADD";
  USER_UNLOCK: "USER_UNLOCK";
  USER_ROLE_DEL: "USER_ROLE_DEL";
  USER_BOOKING_REQUEST: "USER_BOOKING_REQUEST";
  USER_UPDATE_BOOKING_REQUEST: "USER_UPDATE_BOOKING_REQUEST";
  USER_DELETE_BOOKING_REQUEST: "USER_DELETE_BOOKING_REQUEST";
  USER_CANCEL_BOOKING_REQUEST: "USER_CANCEL_BOOKING_REQUEST";
  USER_GET_ADMIN_TK: "USER_GET_ADMIN_TK";
  USER_PROMOCODE_REDEEM: "USER_PROMOCODE_REDEEM";
  USER_SYSTEM_CREDIT_ADD: "USER_SYSTEM_CREDIT_ADD";
  USER_SYSTEM_CREDIT_CONSUMED: "USER_SYSTEM_CREDIT_CONSUMED";
  USER_SYSTEM_CREDIT_REMOVED: "USER_SYSTEM_CREDIT_REMOVED";
  USER_PRODUCT_CHARGED: "USER_PRODUCT_CHARGED";
  USER_TRIP_INVOICE_CREATED: "USER_TRIP_INVOICE_CREATED";
  USER_TRIP_EXPENSE_CREATED: "USER_TRIP_EXPENSE_CREATED";
  USER_TRIP_INVOICE_UPDATED: "USER_TRIP_INVOICE_UPDATED";
  USER_PRODUCT_INVOICE_CREATED: "USER_PRODUCT_INVOICE_CREATED";
  USER_PRODUCT_EXPENSE_CREATED: "USER_PRODUCT_EXPENSE_CREATED";
  USER_PRODUCT_INVOICE_UPDATED: "USER_PRODUCT_INVOICE_UPDATED";
  VEHICLE_ADDED_TO_STATION: "VEHICLE_ADDED_TO_STATION";
  VEHICLE_REMOVED_FROM_STATION: "VEHICLE_REMOVED_FROM_STATION";
  VEHICLE_ALLOCATED: "VEHICLE_ALLOCATED";
  VEHICLE_TOWED: "VEHICLE_TOWED";
  VEHICLE_INTEGRATE_DEL: "VEHICLE_INTEGRATE_DEL";
  VEHICLE_ARCHIVED: "VEHICLE_ARCHIVED";
  VEHICLE_DELETE: "VEHICLE_DELETE";
  VEHICLE_UPDATED: "VEHICLE_UPDATED";
  VEHICLE_UPDATED_VUBOX: "VEHICLE_UPDATED_VUBOX";
  VEHICLE_REMOVE_VUBOX: "VEHICLE_REMOVE_VUBOX";
  VEHICLE_ASSIGN_VUBOX: "VEHICLE_ASSIGN_VUBOX";
  VEHICLE_OUT_OF_SERVICE: "VEHICLE_OUT_OF_SERVICE";
  VEHICLE_SCHEDULED_OUT_OF_SERVICE: "VEHICLE_SCHEDULED_OUT_OF_SERVICE";
  VEHICLE_SCHEDULED_OUT_OF_SERVICE_CANCELED: "VEHICLE_SCHEDULED_OUT_OF_SERVICE_CANCELED";
  VEHICLE_UNLOCK: "VEHICLE_UNLOCK";
  VEHICLE_LOCK: "VEHICLE_LOCK";
  VEHICLE_BATTERY_LOCK: "VEHICLE_BATTERY_LOCK";
  VEHICLE_BATTERY_UNLOCK: "VEHICLE_BATTERY_UNLOCK";
  VEHICLE_HELMET_LOCK: "VEHICLE_HELMET_LOCK";
  VEHICLE_HELMET_UNLOCK: "VEHICLE_HELMET_UNLOCK";
  VEHICLE_SPARE_LOCK: "VEHICLE_SPARE_LOCK";
  VEHICLE_SPARE_UNLOCK: "VEHICLE_SPARE_UNLOCK";
  VEHICLE_PILE_LOCK: "VEHICLE_PILE_LOCK";
  VEHICLE_PILE_UNLOCK: "VEHICLE_PILE_UNLOCK";
  VEHICLE_SPEED_LIMIT_CHANGED: "VEHICLE_SPEED_LIMIT_CHANGED";
  VEHICLE_WAKE_UP: "VEHICLE_WAKE_UP";
  VEHICLE_WAKE_UP_ACCEL: "VEHICLE_WAKE_UP_ACCEL";
  VEHICLE_WAKE_UP_BLE: "VEHICLE_WAKE_UP_BLE";
  VEHICLE_CONNECTIVITY_ONLINE: "VEHICLE_CONNECTIVITY_ONLINE";
  VEHICLE_CONNECTIVITY_OFFLINE: "VEHICLE_CONNECTIVITY_OFFLINE";
  VEHICLE_CONNECTIVITY_INTERRUPTED: "VEHICLE_CONNECTIVITY_INTERRUPTED";
  VEHICLE_OUT_OF_COM: "VEHICLE_OUT_OF_COM";
  VEHICLE_BOOKING_STATUS_CHANGED: "VEHICLE_BOOKING_STATUS_CHANGED";
  VEHICLE_GET_STATUS: "VEHICLE_GET_STATUS";
  VEHICLE_SCHEDULED_REBOOT: "VEHICLE_SCHEDULED_REBOOT";
  VEHICLE_WARNING: "VEHICLE_WARNING";
  VEHICLE_CRUISING_RANGE_LOW: "VEHICLE_CRUISING_RANGE_LOW";
  VEHICLE_CRUISING_RANGE_CRITICAL: "VEHICLE_CRUISING_RANGE_CRITICAL";
  VEHICLE_ACCEL_ALERT: "VEHICLE_ACCEL_ALERT";
  VEHICLE_SPEED_ALERT: "VEHICLE_SPEED_ALERT";
  VEHICLE_CKH_UPDATE: "VEHICLE_CKH_UPDATE";
  VEHICLE_RECOVERY: "VEHICLE_RECOVERY";
  VEHICLE_STANDBY: "VEHICLE_STANDBY";
  VEHICLE_AUTOCLOSE_ON: "VEHICLE_AUTOCLOSE_ON";
  VEHICLE_AUTOCLOSE_OFF: "VEHICLE_AUTOCLOSE_OFF";
  VEHICLE_IGNITION_ON: "VEHICLE_IGNITION_ON";
  VEHICLE_IGNITION_OFF: "VEHICLE_IGNITION_OFF";
  VEHICLE_REBOOT: "VEHICLE_REBOOT";
  VEHICLE_MOBILIZE: "VEHICLE_MOBILIZE";
  VEHICLE_IMMOBILIZE: "VEHICLE_IMMOBILIZE";
  VEHICLE_IMMOBILIZER_OOT: "VEHICLE_IMMOBILIZER_OOT";
  VEHICLE_ENABLE: "VEHICLE_ENABLE";
  VEHICLE_MAGIC_CARD: "VEHICLE_MAGIC_CARD";
  VEHICLE_CLEANLINESS_RESET: "VEHICLE_CLEANLINESS_RESET";
  VEHICLE_ADD_ZONE: "VEHICLE_ADD_ZONE";
  VEHICLE_REMOVE_ZONE: "VEHICLE_REMOVE_ZONE";
  VEHICLE_RELEASE_TRIP: "VEHICLE_RELEASE_TRIP";
  VEHICLE_START_TRIP: "VEHICLE_START_TRIP";
  VEHICLE_END_TRIP: "VEHICLE_END_TRIP";
  VEHICLE_EDIT_TRIP: "VEHICLE_EDIT_TRIP";
  VEHICLE_MANUAL_END_TRIP: "VEHICLE_MANUAL_END_TRIP";
  VEHICLE_TRACKING_ON: "VEHICLE_TRACKING_ON";
  VEHICLE_TRACKING_OFF: "VEHICLE_TRACKING_OFF";
  VEHICLE_TRIP_TERMINATION: "VEHICLE_TRIP_TERMINATION";
  VEHICLE_PAUSE_TRIP: "VEHICLE_PAUSE_TRIP";
  VEHICLE_FORCED_PAUSE_TRIP: "VEHICLE_FORCED_PAUSE_TRIP";
  VEHICLE_RESUME_TRIP: "VEHICLE_RESUME_TRIP";
  VEHICLE_EXPERT: "VEHICLE_EXPERT";
  VEHICLE_PASSTHROUGH: "VEHICLE_PASSTHROUGH";
  VEHICLE_PING: "VEHICLE_PING";
  VEHICLE_CANCEL_TRIP: "VEHICLE_CANCEL_TRIP";
  VEHICLE_REMOVE_PRODUCT_TRIP: "VEHICLE_REMOVE_PRODUCT_TRIP";
  VEHICLE_BOOK: "VEHICLE_BOOK";
  VEHICLE_ADD_PRODUCT_TRIP: "VEHICLE_ADD_PRODUCT_TRIP";
  VEHICLE_UPDATE_REASON: "VEHICLE_UPDATE_REASON";
  VEHICLE_RESET_CLEAN_DATE: "VEHICLE_RESET_CLEAN_DATE";
  VEHICLE_RESET_REDISTRIB_DATE: "VEHICLE_RESET_REDISTRIB_DATE";
  VEHICLE_RESET_MOVING_DATE: "VEHICLE_RESET_MOVING_DATE";
  VEHICLE_RESET_BOOKING_CONTEXT: "VEHICLE_RESET_BOOKING_CONTEXT";
  VEHICLE_ARCHIVED_FM: "VEHICLE_ARCHIVED_FM";
  VEHICLE_CHARGING_ACTIVE: "VEHICLE_CHARGING_ACTIVE";
  VEHICLE_CHARGING_ENDED: "VEHICLE_CHARGING_ENDED";
  VEHICLE_CHARGING_PLUGGED: "VEHICLE_CHARGING_PLUGGED";
  VEHICLE_CHARGING_UNPLUGGED: "VEHICLE_CHARGING_UNPLUGGED";
  VEHICLE_BATTERY_OK: "VEHICLE_BATTERY_OK";
  VEHICLE_BATTERY_LOW: "VEHICLE_BATTERY_LOW";
  VEHICLE_BATTERY_CRITICAL: "VEHICLE_BATTERY_CRITICAL";
  VEHICLE_DOORS_OPEN: "VEHICLE_DOORS_OPEN";
  VEHICLE_DOORS_CLOSED: "VEHICLE_DOORS_CLOSED";
  VEHICLE_WINDOWS_OPEN: "VEHICLE_WINDOWS_OPEN";
  VEHICLE_WINDOWS_CLOSED: "VEHICLE_WINDOWS_CLOSED";
  VEHICLE_ALERT: "VEHICLE_ALERT";
  VEHICLE_FATAL: "VEHICLE_FATAL";
  VEHICLE_PRICING_CHANGED: "VEHICLE_PRICING_CHANGED";
  VEHICLE_GROUP_CHANGED: "VEHICLE_GROUP_CHANGED";
  VEHICLE_UPDATE_ODOMETER: "VEHICLE_UPDATE_ODOMETER";
  VEHICLE_UPDATE_STATUS: "VEHICLE_UPDATE_STATUS";
  VEHICLE_UPDATE_GPS_MANUAL: "VEHICLE_UPDATE_GPS_MANUAL";
  VEHICLE_UPDATE_GPS_SIM: "VEHICLE_UPDATE_GPS_SIM";
  VEHICLE_RFID_SYNC: "VEHICLE_RFID_SYNC";
  VEHICLE_PREAUTH_CONFIRMED: "VEHICLE_PREAUTH_CONFIRMED";
  VEHICLE_PREAUTH_REJECTED: "VEHICLE_PREAUTH_REJECTED";
  VEHICLE_PREAUTH_EXPIRED: "VEHICLE_PREAUTH_EXPIRED";
  VEHICLE_PREAUTH_CANCELLED: "VEHICLE_PREAUTH_CANCELLED";
  USER_PRODUCT_INVOICE_CANCELLED: "USER_PRODUCT_INVOICE_CANCELLED";
  USER_TRIP_INVOICE_CANCELLED: "USER_TRIP_INVOICE_CANCELLED";
  USER_PRODUCT_INVOICE_REFUSED: "USER_PRODUCT_INVOICE_REFUSED";
  USER_TRIP_INVOICE_REFUSED: "USER_TRIP_INVOICE_REFUSED";
  USER_TRIP_INVOICE_PAID: "USER_TRIP_INVOICE_PAID";
  USER_PRODUCT_INVOICE_PAID: "USER_PRODUCT_INVOICE_PAID";
  USER_TRIP_INVOICE_REFUNDED: "USER_TRIP_INVOICE_REFUNDED";
  USER_PRODUCT_INVOICE_REFUNDED: "USER_PRODUCT_INVOICE_REFUNDED";
  USER_PLAN_SUBSCRIBED: "USER_PLAN_SUBSCRIBED";
  USER_PLAN_UNSUBSCRIBED: "USER_PLAN_UNSUBSCRIBED";
  USER_PLAN_EXPIRED: "USER_PLAN_EXPIRED";
  USER_PLAN_RENEWED: "USER_PLAN_RENEWED";
  USER_PLAN_RENEWAL: "USER_PLAN_RENEWAL";
  USER_PLAN_CANCELED: "USER_PLAN_CANCELED";
  USER_PLAN_UPDATED: "USER_PLAN_UPDATED";
  USER_PLAN_PERIODIC_TIME_WALLET_CHARGED: "USER_PLAN_PERIODIC_TIME_WALLET_CHARGED";
  USER_PLAN_PERIODIC_TIME_WALLET_CONSUMED: "USER_PLAN_PERIODIC_TIME_WALLET_CONSUMED";
  USER_REFERRAL_CREATED: "USER_REFERRAL_CREATED";
  USER_REFERRAL_CHECKED: "USER_REFERRAL_CHECKED";
  USER_REPORT_CREATED: "USER_REPORT_CREATED";
  USER_REPORT_UPDATED: "USER_REPORT_UPDATED";
  USER_DOC_UPDATED: "USER_DOC_UPDATED";
  USER_BILLING_GROUP_ADDED: "USER_BILLING_GROUP_ADDED";
  USER_BILLING_GROUP_REMOVED: "USER_BILLING_GROUP_REMOVED";
  VEHICLE_ADDED_TO_SERVICE: "VEHICLE_ADDED_TO_SERVICE";
  VEHICLE_REMOVED_FROM_SERVICE: "VEHICLE_REMOVED_FROM_SERVICE";
  USER_RFIDPINCODE_REQUESTED: "USER_RFIDPINCODE_REQUESTED";
  VEHICLE_REFILLED: "VEHICLE_REFILLED";
  VEHICLE_DIAG_GPS: "VEHICLE_DIAG_GPS";
  VEHICLE_DIAG_CAN: "VEHICLE_DIAG_CAN";
  VEHICLE_DIAG_MOBILIZER: "VEHICLE_DIAG_MOBILIZER";
  VEHICLE_DIAG_IMMOBILIZER: "VEHICLE_DIAG_IMMOBILIZER";
  VEHICLE_DIAG_LOCK: "VEHICLE_DIAG_LOCK";
  VEHICLE_DIAG_UNLOCK: "VEHICLE_DIAG_UNLOCK";
  VEHICLE_DIAG_ANALOG: "VEHICLE_DIAG_ANALOG";
  VEHICLE_DIAG_CKH: "VEHICLE_DIAG_CKH";
  VEHICLE_DIAG_RFID: "VEHICLE_DIAG_RFID";
  VEHICLE_DIAG_SPEAK: "VEHICLE_DIAG_SPEAK";
  VEHICLE_DIAG_HZ_LED: "VEHICLE_DIAG_HZ_LED";
  VEHICLE_BLE_AUTH: "VEHICLE_BLE_AUTH";
  VEHICLE_BLE_START_FLOW: "VEHICLE_BLE_START_FLOW";
  VEHICLE_BLE_START_ISSUE: "VEHICLE_BLE_START_ISSUE";
  VEHICLE_FIRMWARE_UPDATE: "VEHICLE_FIRMWARE_UPDATE";
  VEHICLE_FLEET_SWAP: "VEHICLE_FLEET_SWAP";
  USER_TRIP_EVENT_MAP_DISPLAY_GDPR: "USER_TRIP_EVENT_MAP_DISPLAY_GDPR";
  USER_AUTOMATICALLY_REFUNDED: "USER_AUTOMATICALLY_REFUNDED";
  USER_TRIP_CREDIT_REFUNDED: "USER_TRIP_CREDIT_REFUNDED";
  USER_PRODUCT_CREDIT_REFUNDED: "USER_PRODUCT_CREDIT_REFUNDED";
  USER_PRODUCT_TIME_WALLET_CHARGED: "USER_PRODUCT_TIME_WALLET_CHARGED";
  USER_PRODUCT_TIME_WALLET_CONSUMED: "USER_PRODUCT_TIME_WALLET_CONSUMED";
  USER_CREDIT_REFUNDED: "USER_CREDIT_REFUNDED";
  USER_ALL_CREDIT_REFUNDED: "USER_ALL_CREDIT_REFUNDED";
  USER_PREPAYMENT_SUCCEEDED: "USER_PREPAYMENT_SUCCEEDED";
  USER_PREPAYMENT_FAILED: "USER_PREPAYMENT_FAILED";
  USER_CREATE_SUBSCRIPTION: "USER_CREATE_SUBSCRIPTION";
  USER_UPDATE_SUBSCRIPTION: "USER_UPDATE_SUBSCRIPTION";
  GRACE_PERIOD_APPLIED: "GRACE_PERIOD_APPLIED";
  USER_LABEL_CREATED: "USER_LABEL_CREATED";
  USER_LABEL_DELETED: "USER_LABEL_DELETED";
  VEHICLE_UNAVAILABILITIES_ADD: "VEHICLE_UNAVAILABILITIES_ADD";
  VEHICLE_UNAVAILABILITIES_DELETE: "VEHICLE_UNAVAILABILITIES_DELETE";
  VEHICLE_UNAVAILABILITIES_UPDATE: "VEHICLE_UNAVAILABILITIES_UPDATE";
  VEHICLE_ZONE_IN: "VEHICLE_ZONE_IN";
  VEHICLE_ZONE_OUT: "VEHICLE_ZONE_OUT";
}>;
type EventType = z.infer<typeof EventTypeList>;
type EventFilters = {
  /**
   * Format: yyyy-MM-dd'T'HH:mm:ssZ
   * default now
   */
  startDate?: string;
  /**
   * Format: yyyy-MM-dd'T'HH:mm:ssZ
   * default now plus 2 months
   */
  endDate?: string;
};
declare const getEventsByType: (client: Client, type: EventType, options?: PaginableOptions<EventFilters, "date">) => Promise<PaginableResponse<Event>>;
declare const getEvents: (client: Client, options?: PaginableOptions<EventFilters, "date">) => Promise<PaginableResponse<Event>>;
declare const getEventsByTripId: (client: Client, tripId: string, options?: PaginableOptions<EventFilters, "date">) => Promise<PaginableResponse<Event>>;
//#endregion
export { Event, EventFilters, EventType, ExtraInfo, getEvents, getEventsByTripId, getEventsByType };