@vulog/aima-vehicle 1.2.33 → 1.2.34

package/README.md

@@ -98,6 +98,95 @@ const updatedVehiclesPage = await getVehiclesRealTimePage(client, 0, 100, lastSy
 
 Note: `getVehiclesRealTimePage` is an internal function and is not exported from the package. It's used internally by `getVehiclesRealTime` to handle the pagination logic.
 
+### Create a Vehicle
+
+Creates a new vehicle in the fleet.
+
+```javascript
+import { createVehicle } from '@vulog/aima-vehicle';
+
+const vehicle = await createVehicle(client, {
+    vin: '1HGBH41JXMN109186',
+    plate: 'AB-123-CD',
+    name: 'My Vehicle',
+    model: { id: 372 },
+    // optional fields
+    vuboxId: 'vubox-123',
+    externalId: 'ext-123',
+    noBox: false,
+    published: true,
+});
+```
+
+### Get Options
+
+Fetches all vehicle options available in the fleet.
+
+```javascript
+import { getOptions } from '@vulog/aima-vehicle';
+
+const options = await getOptions(client);
+```
+
+### Add / Remove Option for Vehicle
+
+Add or remove an option to/from a vehicle.
+
+```javascript
+import { addOptionForVehicle, removeOptionForVehicle } from '@vulog/aima-vehicle';
+
+const vehicle = await addOptionForVehicle(client, 'vehicle-uuid', 25);
+const vehicle = await removeOptionForVehicle(client, 'vehicle-uuid', 25);
+```
+
+### Add / Remove Service for Vehicle
+
+Add or remove a service to/from a vehicle.
+
+```javascript
+import { addServiceForVehicle, removeServiceForVehicle } from '@vulog/aima-vehicle';
+
+await addServiceForVehicle(client, 'service-uuid', 'vehicle-uuid');
+await removeServiceForVehicle(client, 'service-uuid', 'vehicle-uuid');
+```
+
+### Enable / Disable Vehicle
+
+Enable or disable a vehicle with a sub-status.
+
+```javascript
+import { enableVehicle, disableVehicle } from '@vulog/aima-vehicle';
+
+await enableVehicle(client, 'vehicle-uuid', { subStatus: 'AVAILABLE' });
+await disableVehicle(client, 'vehicle-uuid', { subStatus: 'MAINTENANCE' });
+```
+
+### Ping Vehicle
+
+Check if a vehicle box is connected.
+
+```javascript
+import { pingVehicleById } from '@vulog/aima-vehicle';
+
+const isConnected = await pingVehicleById(client, 'vehicle-uuid');
+// true = connected, false = connection problem
+```
+
+### Get Model Vehicles
+
+Fetches paginated model vehicle listings.
+
+```javascript
+import { getModelVehicles } from '@vulog/aima-vehicle';
+
+const result = await getModelVehicles(client, {
+    page: 0,
+    pageSize: 50,
+    sort: 'modelId',
+    sortDirection: 'DESC',
+});
+```
+
 ## Types
 
 ### Vehicle

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-vehicle",
     "type": "module",
-    "version": "1.2.33",
+    "version": "1.2.34",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -32,8 +32,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.33",
-        "@vulog/aima-core": "1.2.33"
+        "@vulog/aima-client": "1.2.34",
+        "@vulog/aima-core": "1.2.34"
     },
     "peerDependencies": {
         "zod": "^3.25.76"