@vulog/aima-booking 1.2.30 → 1.2.32

package/dist/index.d.cts

@@ -0,0 +1,362 @@
+import { Client } from "@vulog/aima-client";
+import { PaginableOptions, PaginableResponse } from "@vulog/aima-core";
+import z$1, { z } from "zod";
+import { UUID } from "crypto";
+
+//#region src/types.d.ts
+type PaymentReceipts = {
+  id: string;
+  pspName: string;
+  pspReference: string;
+  amount: number;
+  currency: string;
+  date: string;
+  status: string;
+  paymentMethodType: string;
+  paymentIntentPspReference?: string;
+  number: number;
+  metadatas: {
+    scope: string;
+  };
+};
+/** Payment intent or receipt item as returned by trigger BR payment (and similar payment endpoints). */
+type BRPaymentItem = {
+  id: string;
+  pspName: string;
+  pspReference: string;
+  pspPublishableKey: string;
+  amount: number;
+  currency: string;
+  date: string;
+  captureBefore: string;
+  status: string;
+  paymentMethodType: string;
+  paymentMethodPspReference: string;
+  paymentIntentPspReference: string;
+  number: number;
+  code?: string;
+  declineCode?: string;
+  pspClientSecret?: string;
+  reason?: string;
+  note?: string;
+  nextAction?: {
+    nextActionRedirectUrl: {
+      url: string;
+      method: string;
+      data: Record<string, string>;
+    };
+    type: string;
+  };
+  metadatas: Record<string, string>;
+};
+/** Credit entry in a booking request (e.g. trigger BR payment response). */
+type BookingCredit = {
+  id: string;
+  fleetId: string;
+  amount: number;
+  availableAmount: number;
+  status: string;
+  walletId: string;
+  date: string;
+};
+/** Preferred payment method entry in request/response. */
+type PreferredPaymentMethod = {
+  pspReference: string;
+  amount: number;
+};
+type CustomPrice = {
+  id: string;
+  fleetId: string;
+  type: 'CUSTOM_FIXED_PRICE' | 'EXTENDED_FIXED_PRICE';
+  amount: number;
+  reason: string;
+  pricingReferenceId: string | null;
+};
+type BaseBookingRequest = {
+  bookingReferenceId?: string;
+  cityId: string;
+  completed: boolean;
+  contractType?: string;
+  creationDate: string;
+  customPrice: CustomPrice | null;
+  deliveryAddress?: string;
+  deliveryAddressAdditionalInfo?: string;
+  deliveryCity?: string;
+  deliveryPostalCode?: string;
+  dropOffStation?: string;
+  fleetId: string;
+  id: string;
+  notes?: string;
+  planDurationInMonths?: number;
+  plannedReturnDate?: string;
+  pricingDetails: {
+    pricingId: string;
+    providerType: string;
+  }[];
+  productIds: string[];
+  profileId: string;
+  rollingContract: boolean;
+  serviceId: string;
+  startDate: string;
+  status: string;
+  userId: string;
+};
+type BookingRequest = BaseBookingRequest & {
+  [key: string]: any;
+  cancellationDate?: string;
+  cancelledBy?: string;
+  credit?: string;
+  endDate: string;
+  entityName?: string;
+  journeyId?: string;
+  modelId: number;
+  modelName?: string;
+  paymentReceipts?: PaymentReceipts[];
+  pricePerUnit?: string;
+  profileType?: 'Single' | 'Business';
+  realStartDate?: string;
+  returnedDate?: string;
+  station: string;
+  vehicleId?: string;
+  vehicleResidualValue?: number;
+  warning?: string;
+};
+type SATBookingRequest = BaseBookingRequest & {
+  cancellationDate: string | null;
+  cancelledBy: string | null;
+  endDate: string | null;
+  entityName: string | null;
+  journeyId: string | null;
+  modelId: number | null;
+  profileType: string | null;
+  realStartDate: string | null;
+  returnedDate: string | null;
+  station: string | null;
+  vehicleId: string | null;
+  cancellationFeeAmount: number | null;
+  credits: string | null;
+  earlyCancelledByUser: boolean;
+  email: string | null;
+  failureReason: string | null;
+  latitude: number;
+  longitude: number;
+  parentId: string | null;
+  planName: string | null;
+  preallocatedVehicleId: string | null;
+  previous: any | null;
+  price: any | null;
+  radius: number;
+  requiresActionReturnURL: string | null;
+  thresholdDateLimit: string | null;
+  trip: any | null;
+  warning: string | null;
+};
+/** Response of the trigger BR payment endpoint (booking request + payment intents/receipts). */
+type TriggerBRPaymentResponse = Omit<SATBookingRequest, 'credits'> & {
+  paymentIntents: BRPaymentItem[];
+  paymentReceipts: BRPaymentItem[];
+  credits: BookingCredit[];
+  preferredPaymentMethods?: PreferredPaymentMethod[];
+};
+type GeoInfo = {
+  name: string;
+  coordinates: {
+    latitude: number;
+    longitude: number;
+  };
+  geoProperties: {
+    [key: string]: any;
+  };
+};
+type Service = {
+  id: string;
+  models: {
+    id: number;
+    vehicles: string[];
+  }[];
+};
+type ServiceInfo = {
+  services: Service[];
+};
+type Days = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+type DayOpeningHours = {
+  id: number;
+  closed: boolean;
+  openAt: string;
+  closeAt: string;
+};
+type Timetable = Record<Days, DayOpeningHours[]>;
+type OpeningHours = {
+  alwaysOpen: boolean;
+  timetable: Timetable;
+};
+type Station = Partial<GeoInfo> & Partial<ServiceInfo> & {
+  id: string;
+  zoneId: string;
+  poiId: string;
+  modificationDate: string;
+  fleetId: string;
+  openingHours?: OpeningHours;
+  [key: string]: any;
+};
+/** Vehicle as returned by the available vehicles endpoint. */
+type Vehicle = {
+  vehicleId: string;
+  [key: string]: unknown;
+};
+/** Response of the subscription stations vehicles/available endpoint. */
+type AvailableVehiclesResponse = {
+  stationId: string;
+  vehicles: Vehicle[];
+};
+//#endregion
+//#region src/getBookingRequests.d.ts
+declare const BookingRequestStatusSchema: z.ZodEnum<["ALERT", "UPCOMING", "ONGOING", "COMPLETED", "CANCELLED", "PENDING_APPROVAL", "CONFIRMED", "PENDING", "LATE"]>;
+type BookingRequestStatus = z.infer<typeof BookingRequestStatusSchema>;
+declare const ServiceTypeSchema: z.ZodEnum<["SUBSCRIPTION", "ROUND_TRIP_BOOKING", "SCHEDULED_BOOKING_STATION"]>;
+type ServiceType = z.infer<typeof ServiceTypeSchema>;
+type SpecificBookingRequestFilters = {
+  serviceIds?: string[];
+  userId?: string;
+  modelId?: number;
+  vehicleId?: string;
+  stationId?: string;
+  /**
+   * Format: yyyy-MM-dd
+   */
+  creationDate?: string;
+  /**
+   * 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;
+  includeProducts?: 'true' | 'false';
+};
+type BookingRequestFilters = SpecificBookingRequestFilters & {
+  serviceTypes?: ServiceType[];
+};
+declare const getBookingRequests: (client: Client, status: BookingRequestStatus, options?: PaginableOptions<BookingRequestFilters>) => Promise<PaginableResponse<BookingRequest>>;
+declare const getScheduleBookingRequests: (client: Client, status: BookingRequestStatus, options?: PaginableOptions<SpecificBookingRequestFilters>) => Promise<PaginableResponse<BookingRequest>>;
+declare const getSubscriptionBookingRequests: (client: Client, status: BookingRequestStatus, options?: PaginableOptions<SpecificBookingRequestFilters>) => Promise<PaginableResponse<BookingRequest>>;
+//#endregion
+//#region src/getSATBookingRequests.d.ts
+declare const SATBookingRequestStatusSchema: z.ZodEnum<["ALERT", "CANCELLED", "COMPLETED", "CONFIRMED", "LATE_RETURN", "ONGOING", "PENDING_PAYMENT", "PENDING", "UPCOMING_ALLOCATED", "UPCOMING_NOT_ALLOCATED"]>;
+type SATBookingRequestStatus = z.infer<typeof SATBookingRequestStatusSchema>;
+declare const getSATBookingRequests: (client: Client, status: SATBookingRequestStatus, options?: PaginableOptions<void, keyof SATBookingRequest>) => Promise<PaginableResponse<SATBookingRequest>>;
+//#endregion
+//#region src/getBookingRequest.d.ts
+declare const getBookingRequestById: (client: Client, id: string) => Promise<BookingRequest>;
+declare const getBookingRequestByTrip: (client: Client, tripId: string) => Promise<BookingRequest>;
+declare const getSubscriptionBookingRequestById: (client: Client, id: string) => Promise<BookingRequest>;
+//#endregion
+//#region src/getAvailableVehicles.d.ts
+declare const getAvailableVehicles: (client: Client, stationId: string, startDate: string) => Promise<AvailableVehiclesResponse>;
+//#endregion
+//#region src/getStations.d.ts
+declare const IncludeSchema$1: z.ZodEnum<["INFO", "OPEN_HOUR", "SERVICES"]>;
+type Include = z.infer<typeof IncludeSchema$1>;
+declare const getStations: (client: Client, includes?: Include[]) => Promise<Station[]>;
+//#endregion
+//#region src/getStation.d.ts
+declare const IncludeSchema: z.ZodEnum<["INFO", "SERVICES"]>;
+type IncludeStation = z.infer<typeof IncludeSchema>;
+declare const getStationById: (client: Client, id: string, includes?: IncludeStation[]) => Promise<Station | null>;
+//#endregion
+//#region src/allocateVehicle.d.ts
+declare const allocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID, serviceId: UUID) => Promise<SATBookingRequest>;
+//#endregion
+//#region src/deallocateVehicle.d.ts
+declare const deallocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID) => Promise<SATBookingRequest>;
+//#endregion
+//#region src/updateScheduleBooking.d.ts
+declare const updateScheduleBooking: (client: Client, bookingRequestId: string, updateData: Record<string, unknown>) => Promise<SATBookingRequest>;
+//#endregion
+//#region src/triggerBRPayment.d.ts
+declare const triggerBRPaymentSchema: z$1.ZodObject<{
+  bookingRequestId: z$1.ZodString;
+  body: z$1.ZodObject<{
+    scope: z$1.ZodEnum<["RENTAL", "DEPOSIT"]>;
+    requiresActionReturnURL: z$1.ZodOptional<z$1.ZodString>;
+    online: z$1.ZodBoolean;
+    amountType: z$1.ZodEnum<["FIXED", "PERCENTAGE"]>;
+    amountValue: z$1.ZodNumber;
+    preferredPaymentMethods: z$1.ZodOptional<z$1.ZodArray<z$1.ZodObject<{
+      pspReference: z$1.ZodString;
+      amount: z$1.ZodDefault<z$1.ZodNumber>;
+    }, "strip", z$1.ZodTypeAny, {
+      pspReference: string;
+      amount: number;
+    }, {
+      pspReference: string;
+      amount?: number | undefined;
+    }>, "many">>;
+    profileId: z$1.ZodString;
+  }, "strip", z$1.ZodTypeAny, {
+    profileId: string;
+    scope: "RENTAL" | "DEPOSIT";
+    online: boolean;
+    amountType: "FIXED" | "PERCENTAGE";
+    amountValue: number;
+    requiresActionReturnURL?: string | undefined;
+    preferredPaymentMethods?: {
+      pspReference: string;
+      amount: number;
+    }[] | undefined;
+  }, {
+    profileId: string;
+    scope: "RENTAL" | "DEPOSIT";
+    online: boolean;
+    amountType: "FIXED" | "PERCENTAGE";
+    amountValue: number;
+    requiresActionReturnURL?: string | undefined;
+    preferredPaymentMethods?: {
+      pspReference: string;
+      amount?: number | undefined;
+    }[] | undefined;
+  }>;
+}, "strip", z$1.ZodTypeAny, {
+  bookingRequestId: string;
+  body: {
+    profileId: string;
+    scope: "RENTAL" | "DEPOSIT";
+    online: boolean;
+    amountType: "FIXED" | "PERCENTAGE";
+    amountValue: number;
+    requiresActionReturnURL?: string | undefined;
+    preferredPaymentMethods?: {
+      pspReference: string;
+      amount: number;
+    }[] | undefined;
+  };
+}, {
+  bookingRequestId: string;
+  body: {
+    profileId: string;
+    scope: "RENTAL" | "DEPOSIT";
+    online: boolean;
+    amountType: "FIXED" | "PERCENTAGE";
+    amountValue: number;
+    requiresActionReturnURL?: string | undefined;
+    preferredPaymentMethods?: {
+      pspReference: string;
+      amount?: number | undefined;
+    }[] | undefined;
+  };
+}>;
+declare const triggerBRPayment: (client: Client, bookingRequestId: UUID, body: z$1.infer<typeof triggerBRPaymentSchema>["body"]) => Promise<TriggerBRPaymentResponse>;
+//#endregion
+//#region src/getBookingRequestsByUserId.d.ts
+declare const getBookingRequestsByUserId: (client: Client, userId: string) => Promise<BookingRequest[]>;
+//#endregion
+//#region src/releaseBRPayment.d.ts
+declare const releaseBRPayment: (client: Client, bookingRequestId: UUID, pspReference: string) => Promise<SATBookingRequest>;
+//#endregion
+//#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 };