@vulog/aima-trip

Trip management — retrieve trips, booked vehicles, and manage trip-related products.

Installation

npm install @vulog/aima-trip @vulog/aima-client @vulog/aima-core

Usage

import { getTripById, getVehiclesBooked, endTrip } from '@vulog/aima-trip';
import { getClient } from '@vulog/aima-client';

const client = getClient({ ... });

const trip = await getTripById(client, 'trip-uuid');
const booked = await getVehiclesBooked(client, { minDuration: 60 });

API Reference

getTripById

getTripById(client: Client, tripId: string): Promise<Trip | Record<string, never>>

Fetches a trip by ID. Returns an empty object if the trip is not found (404).

| Param | Type | Description | | -------- | -------- | ------------------------- | | client | Client | Authenticated AIMA client | | tripId | string | Trip unique identifier |

getVehiclesBooked

getVehiclesBooked(client: Client, options?: { minDuration?: number; boxStatus?: number[] }): Promise<FleetManagerBook[]>

Returns all vehicles currently booked in the fleet. minDuration and boxStatus filters are applied client-side after the fetch.

| Param | Type | Description | | --------- | ------------------------------------------------ | ------------------------------ | | client | Client | Authenticated AIMA client | | options | { minDuration?: number; boxStatus?: number[] } | Client-side filters (optional) |

getVehiclesBookedByUserId

getVehiclesBookedByUserId(client: Client, userId: string): Promise<FleetManagerBook[]>

Returns all vehicles currently booked by a specific user.

| Param | Type | Description | | -------- | -------- | ------------------------- | | client | Client | Authenticated AIMA client | | userId | string | User identifier |

getVehicleBookedByTripId

getVehicleBookedByTripId(client: Client, tripId: string): Promise<FleetManagerBook | null>

Returns the booked vehicle for a given trip ID, or null on 404.

| Param | Type | Description | | -------- | -------- | ------------------------- | | client | Client | Authenticated AIMA client | | tripId | string | Trip identifier |

addTripRelatedProduct

addTripRelatedProduct(client: Client, vehicleId: string, productId: string): Promise<void>

Adds a product to a vehicle's active trip.

| Param | Type | Description | | ----------- | -------- | ------------------------- | | client | Client | Authenticated AIMA client | | vehicleId | string | Vehicle identifier | | productId | string | Product identifier |

removeTripRelatedProduct

removeTripRelatedProduct(client: Client, vehicleId: string, productId: string): Promise<void>

Removes a product from a vehicle's active trip.

| Param | Type | Description | | ----------- | -------- | ------------------------- | | client | Client | Authenticated AIMA client | | vehicleId | string | Vehicle identifier | | productId | string | Product identifier |

endTrip

endTrip(client: Client, info: EndTripInfo): Promise<void>

Ends a trip for a vehicle.

| Param | Type | Description | | -------- | ------------- | ------------------------- | | client | Client | Authenticated AIMA client | | info | EndTripInfo | End-trip payload |

getOngoingTripPaymentsByTripIds

getOngoingTripPaymentsByTripIds(client: Client, tripIds: string[]): Promise<Payment[]>

Fetches payment state for multiple trips in a single call.

| Param | Type | Description | | --------- | ---------- | ------------------------- | | client | Client | Authenticated AIMA client | | tripIds | string[] | List of trip identifiers |

getTripsByUserId

getTripsByUserId(client: Client, userId: string, options?: PaginableOptions<void, 'date'>): Promise<PaginableResponse<Trip>>

Returns a paginated list of trips for a specific user.

| Param | Type | Description | | -------- | --------------------------------- | ------------------------- | | client | Client | Authenticated AIMA client | | userId | string | User identifier | | options| PaginableOptions<void, 'date'> | Pagination options |

Types

Trip

{
    id, tripId, fleetId, userId, profileId, profileType, vehicleId,
    length, duration, pauseDuration, tripDuration, bookingDuration,
    drivingDuration, date, endDate, additionalInfo, pricingId, productIds,
    serviceId, serviceType, theorStartDate, theorEndDate, ticketInfo,
    tripEvents, lastUpdateDate
}

EndTripInfo

{
    vehicleId: string;
    userId: string;
    orderId: string;
}

FleetManagerBook

Real-time booking shape including vehicle telemetry, booking state, and zone information.

Payment

{
    id, fleetId, profileId, vehicleId, serviceId,
    paymentReceipts: PaymentReceipt[]
}

PaymentReceipt

Payment receipt details associated with a trip payment.