@vulog/aima-booking 1.2.32 → 1.2.34

package/README.md

@@ -139,6 +139,109 @@ Get a specific station by ID.
 const station = await getStationById(client, 'station-id-here', ['OPEN_HOUR', 'INFO']);
 ```
 
+### Vehicle Allocation
+
+#### allocateVehicle
+
+Allocate a vehicle to a booking request.
+
+```javascript
+import { allocateVehicle } from '@vulog/aima-booking';
+
+const result = await allocateVehicle(client, 'booking-request-uuid', 'vehicle-uuid', 'service-uuid');
+```
+
+#### deallocateVehicle
+
+Deallocate a vehicle from a booking request.
+
+```javascript
+import { deallocateVehicle } from '@vulog/aima-booking';
+
+await deallocateVehicle(client, 'booking-request-uuid');
+```
+
+### Booking Actions
+
+#### updateScheduleBooking
+
+Update a scheduled booking.
+
+```javascript
+import { updateScheduleBooking } from '@vulog/aima-booking';
+
+await updateScheduleBooking(client, 'booking-request-uuid', { endDate: '2024-02-15T00:00:00Z' });
+```
+
+#### cancelBookingRequest
+
+Cancel a booking request.
+
+```javascript
+import { cancelBookingRequest } from '@vulog/aima-booking';
+
+await cancelBookingRequest(client, 'booking-request-uuid');
+```
+
+#### triggerBRPayment / releaseBRPayment
+
+Trigger or release payment for a booking request.
+
+```javascript
+import { triggerBRPayment, releaseBRPayment } from '@vulog/aima-booking';
+
+await triggerBRPayment(client, 'booking-request-uuid');
+await releaseBRPayment(client, 'booking-request-uuid');
+```
+
+#### getBookingRequestsByUserId
+
+Get booking requests for a specific user.
+
+```javascript
+import { getBookingRequestsByUserId } from '@vulog/aima-booking';
+
+const requests = await getBookingRequestsByUserId(client, 'user-uuid');
+```
+
+### Subscriptions
+
+#### createSubscription
+
+Create a new subscription booking request.
+
+```javascript
+import { createSubscription } from '@vulog/aima-booking';
+
+const subscription = await createSubscription(client, {
+    userId: 'user-uuid',
+    profileId: 'profile-uuid',
+    startDate: '2024-01-15T00:00:00Z',
+    endDate: '2024-07-15T00:00:00Z',
+    vehicleId: 'vehicle-uuid',
+    modelId: 372,
+    station: 'station-uuid',
+    serviceId: 'service-uuid',
+    // optional fields
+    pricingId: 'pricing-uuid',
+    notes: 'VIP client',
+    isRollingContract: false,
+    additionalDriverInvitations: ['driver@example.com'],
+});
+```
+
+### Available Vehicles
+
+#### getAvailableVehicles
+
+Get available vehicles for booking.
+
+```javascript
+import { getAvailableVehicles } from '@vulog/aima-booking';
+
+const vehicles = await getAvailableVehicles(client);
+```
+
 ## Types
 
 ### BookingRequest

package/dist/index.cjs

@@ -446,8 +446,38 @@ const cancelBookingRequest = async (client, id) => {
 	});
 };
 //#endregion
+//#region src/createSubscription.ts
+const createSubscriptionBodySchema = zod.z.object({
+	userId: zod.z.string().trim().min(1).uuid(),
+	profileId: zod.z.string().trim().min(1).uuid(),
+	startDate: zod.z.string().trim().min(1),
+	endDate: zod.z.string().trim().min(1),
+	vehicleId: zod.z.string().trim().min(1).uuid(),
+	modelId: zod.z.number().int().positive(),
+	station: zod.z.string().trim().min(1).uuid(),
+	serviceId: zod.z.string().trim().min(1).uuid(),
+	pricingId: zod.z.string().optional(),
+	productList: zod.z.array(zod.z.string()).optional(),
+	deliveryAddress: zod.z.string().optional(),
+	deliveryAddressAdditionalInfo: zod.z.string().optional(),
+	deliveryCity: zod.z.string().optional(),
+	deliveryPostalCode: zod.z.string().optional(),
+	plannedReturnDate: zod.z.string().optional(),
+	notes: zod.z.string().optional(),
+	isRollingContract: zod.z.boolean().optional(),
+	parentId: zod.z.string().optional(),
+	bookingReferenceId: zod.z.string().optional(),
+	additionalDriverInvitations: zod.z.array(zod.z.string().email()).optional()
+});
+const createSubscription = async (client, body) => {
+	const result = createSubscriptionBodySchema.safeParse(body);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.post(`/boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/subscription/bookingrequests`, result.data).then(({ data }) => data);
+};
+//#endregion
 exports.allocateVehicle = allocateVehicle;
 exports.cancelBookingRequest = cancelBookingRequest;
+exports.createSubscription = createSubscription;
 exports.deallocateVehicle = deallocateVehicle;
 exports.getAvailableVehicles = getAvailableVehicles;
 exports.getBookingRequestById = getBookingRequestById;

package/dist/index.d.cts

@@ -359,4 +359,29 @@ declare const releaseBRPayment: (client: Client, bookingRequestId: UUID, pspRefe
 //#region src/cancelBookingRequest.d.ts
 declare const cancelBookingRequest: (client: Client, id: string) => Promise<SATBookingRequest>;
 //#endregion
-export { AvailableVehiclesResponse, BRPaymentItem, BaseBookingRequest, BookingCredit, BookingRequest, type BookingRequestFilters, type BookingRequestStatus, CustomPrice, DayOpeningHours, Days, GeoInfo, type Include, type IncludeStation, OpeningHours, PaymentReceipts, PreferredPaymentMethod, SATBookingRequest, type SATBookingRequestStatus, Service, ServiceInfo, type ServiceType, Station, Timetable, TriggerBRPaymentResponse, Vehicle, allocateVehicle, cancelBookingRequest, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };
+//#region src/createSubscription.d.ts
+type CreateSubscriptionBody = {
+  userId: string;
+  profileId: string;
+  startDate: string;
+  endDate: string;
+  vehicleId: string;
+  modelId: number;
+  station: string;
+  serviceId: string;
+  pricingId?: string;
+  productList?: string[];
+  deliveryAddress?: string;
+  deliveryAddressAdditionalInfo?: string;
+  deliveryCity?: string;
+  deliveryPostalCode?: string;
+  plannedReturnDate?: string;
+  notes?: string;
+  isRollingContract?: boolean;
+  parentId?: string;
+  bookingReferenceId?: string;
+  additionalDriverInvitations?: string[];
+};
+declare const createSubscription: (client: Client, body: CreateSubscriptionBody) => Promise<BookingRequest>;
+//#endregion
+export { AvailableVehiclesResponse, BRPaymentItem, BaseBookingRequest, BookingCredit, BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type CreateSubscriptionBody, CustomPrice, DayOpeningHours, Days, GeoInfo, type Include, type IncludeStation, OpeningHours, PaymentReceipts, PreferredPaymentMethod, SATBookingRequest, type SATBookingRequestStatus, Service, ServiceInfo, type ServiceType, Station, Timetable, TriggerBRPaymentResponse, Vehicle, allocateVehicle, cancelBookingRequest, createSubscription, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };

package/dist/index.d.mts

@@ -359,4 +359,29 @@ declare const releaseBRPayment: (client: Client, bookingRequestId: UUID, pspRefe
 //#region src/cancelBookingRequest.d.ts
 declare const cancelBookingRequest: (client: Client, id: string) => Promise<SATBookingRequest>;
 //#endregion
-export { AvailableVehiclesResponse, BRPaymentItem, BaseBookingRequest, BookingCredit, BookingRequest, type BookingRequestFilters, type BookingRequestStatus, CustomPrice, DayOpeningHours, Days, GeoInfo, type Include, type IncludeStation, OpeningHours, PaymentReceipts, PreferredPaymentMethod, SATBookingRequest, type SATBookingRequestStatus, Service, ServiceInfo, type ServiceType, Station, Timetable, TriggerBRPaymentResponse, Vehicle, allocateVehicle, cancelBookingRequest, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };
+//#region src/createSubscription.d.ts
+type CreateSubscriptionBody = {
+  userId: string;
+  profileId: string;
+  startDate: string;
+  endDate: string;
+  vehicleId: string;
+  modelId: number;
+  station: string;
+  serviceId: string;
+  pricingId?: string;
+  productList?: string[];
+  deliveryAddress?: string;
+  deliveryAddressAdditionalInfo?: string;
+  deliveryCity?: string;
+  deliveryPostalCode?: string;
+  plannedReturnDate?: string;
+  notes?: string;
+  isRollingContract?: boolean;
+  parentId?: string;
+  bookingReferenceId?: string;
+  additionalDriverInvitations?: string[];
+};
+declare const createSubscription: (client: Client, body: CreateSubscriptionBody) => Promise<BookingRequest>;
+//#endregion
+export { AvailableVehiclesResponse, BRPaymentItem, BaseBookingRequest, BookingCredit, BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type CreateSubscriptionBody, CustomPrice, DayOpeningHours, Days, GeoInfo, type Include, type IncludeStation, OpeningHours, PaymentReceipts, PreferredPaymentMethod, SATBookingRequest, type SATBookingRequestStatus, Service, ServiceInfo, type ServiceType, Station, Timetable, TriggerBRPaymentResponse, Vehicle, allocateVehicle, cancelBookingRequest, createSubscription, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };

package/dist/index.mjs

@@ -422,4 +422,33 @@ const cancelBookingRequest = async (client, id) => {
 	});
 };
 //#endregion
-export { allocateVehicle, cancelBookingRequest, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };
+//#region src/createSubscription.ts
+const createSubscriptionBodySchema = z.object({
+	userId: z.string().trim().min(1).uuid(),
+	profileId: z.string().trim().min(1).uuid(),
+	startDate: z.string().trim().min(1),
+	endDate: z.string().trim().min(1),
+	vehicleId: z.string().trim().min(1).uuid(),
+	modelId: z.number().int().positive(),
+	station: z.string().trim().min(1).uuid(),
+	serviceId: z.string().trim().min(1).uuid(),
+	pricingId: z.string().optional(),
+	productList: z.array(z.string()).optional(),
+	deliveryAddress: z.string().optional(),
+	deliveryAddressAdditionalInfo: z.string().optional(),
+	deliveryCity: z.string().optional(),
+	deliveryPostalCode: z.string().optional(),
+	plannedReturnDate: z.string().optional(),
+	notes: z.string().optional(),
+	isRollingContract: z.boolean().optional(),
+	parentId: z.string().optional(),
+	bookingReferenceId: z.string().optional(),
+	additionalDriverInvitations: z.array(z.string().email()).optional()
+});
+const createSubscription = async (client, body) => {
+	const result = createSubscriptionBodySchema.safeParse(body);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.post(`/boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/subscription/bookingrequests`, result.data).then(({ data }) => data);
+};
+//#endregion
+export { allocateVehicle, cancelBookingRequest, createSubscription, deallocateVehicle, getAvailableVehicles, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getBookingRequestsByUserId, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests, releaseBRPayment, triggerBRPayment, updateScheduleBooking };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-booking",
     "type": "module",
-    "version": "1.2.32",
+    "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.32",
-        "@vulog/aima-core": "1.2.32"
+        "@vulog/aima-client": "1.2.34",
+        "@vulog/aima-core": "1.2.34"
     },
     "peerDependencies": {
         "es-toolkit": "^1.39.9",

package/src/createSubscription.ts

@@ -0,0 +1,64 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { BookingRequest } from './types';
+
+export type CreateSubscriptionBody = {
+    userId: string;
+    profileId: string;
+    startDate: string;
+    endDate: string;
+    vehicleId: string;
+    modelId: number;
+    station: string;
+    serviceId: string;
+    pricingId?: string;
+    productList?: string[];
+    deliveryAddress?: string;
+    deliveryAddressAdditionalInfo?: string;
+    deliveryCity?: string;
+    deliveryPostalCode?: string;
+    plannedReturnDate?: string;
+    notes?: string;
+    isRollingContract?: boolean;
+    parentId?: string;
+    bookingReferenceId?: string;
+    additionalDriverInvitations?: string[];
+};
+
+const createSubscriptionBodySchema = z.object({
+    userId: z.string().trim().min(1).uuid(),
+    profileId: z.string().trim().min(1).uuid(),
+    startDate: z.string().trim().min(1),
+    endDate: z.string().trim().min(1),
+    vehicleId: z.string().trim().min(1).uuid(),
+    modelId: z.number().int().positive(),
+    station: z.string().trim().min(1).uuid(),
+    serviceId: z.string().trim().min(1).uuid(),
+    pricingId: z.string().optional(),
+    productList: z.array(z.string()).optional(),
+    deliveryAddress: z.string().optional(),
+    deliveryAddressAdditionalInfo: z.string().optional(),
+    deliveryCity: z.string().optional(),
+    deliveryPostalCode: z.string().optional(),
+    plannedReturnDate: z.string().optional(),
+    notes: z.string().optional(),
+    isRollingContract: z.boolean().optional(),
+    parentId: z.string().optional(),
+    bookingReferenceId: z.string().optional(),
+    additionalDriverInvitations: z.array(z.string().email()).optional(),
+});
+
+export const createSubscription = async (client: Client, body: CreateSubscriptionBody): Promise<BookingRequest> => {
+    const result = createSubscriptionBodySchema.safeParse(body);
+    if (!result.success) {
+        throw new TypeError('Invalid args', { cause: result.error.issues });
+    }
+
+    return client
+        .post<BookingRequest>(
+            `/boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/subscription/bookingrequests`,
+            result.data
+        )
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -16,3 +16,5 @@ export { triggerBRPayment } from './triggerBRPayment';
 export { getBookingRequestsByUserId } from './getBookingRequestsByUserId';
 export { releaseBRPayment } from './releaseBRPayment';
 export { cancelBookingRequest } from './cancelBookingRequest';
+export { createSubscription } from './createSubscription';
+export type { CreateSubscriptionBody } from './createSubscription';