mts-booking-library 1.1.10 → 1.2.1

package/lib/booking/subscriptionBooking.js

@@ -52,6 +52,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionBooking = void 0;
+var ErrorResponse_1 = require("../types/ErrorResponse");
 var booking_1 = require("./booking");
 var SubscriptionBooking = /** @class */ (function (_super) {
     __extends(SubscriptionBooking, _super);
@@ -90,7 +91,14 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                     if (cartDate > new Date()) {
                         _this.cart = cart;
                         _this.bookingDueDate = cartDate; // See Booking class
-                        _this.cartStatus = cart.status;
+                        // Fill the booking process status
+                        _this.bookingStepsToStatus = new Map(Object.entries(cart.stepsToStatus).map(function (_a) {
+                            var bookingStep = _a[0], values = _a[1];
+                            return [
+                                bookingStep,
+                                values
+                            ];
+                        }));
                         _this.createCartTimer(cartDate);
                     }
                 });
@@ -105,7 +113,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                 setTimeout(function () {
                     localStorage.removeItem("cartId");
                     // Put actions that have to be done when timer expires here
-                    _this.cartStatus = booking_1.Booking.CartStatus.EMPTY;
+                    _this.bookingStepsToStatus = new Map();
                     _this.cart = undefined;
                     _this.bookingDueDate = undefined; // See Booking class
                     _this.onCartExpiration();
@@ -119,7 +127,13 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             var url;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/booking/cart?").concat(new URLSearchParams({ cartId: cartId.toString() }));
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            localStorage.removeItem("cartId");
+                            throw new Error("Error ".concat(response.httpStatus, " ").concat(response.message));
+                        }
+                        return response.cart;
+                    })];
             });
         });
     };
@@ -132,7 +146,9 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             var url;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/departures?");
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.departures;
+                    })];
             });
         });
     };
@@ -147,7 +163,9 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 searchParams = new URLSearchParams({ departureStopName: departureStopName });
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/destinations?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.destinations;
+                    })];
             });
         });
     };
@@ -167,7 +185,9 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                     destinationStopName: destinationStopName
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/validityTypes?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.validityTypes;
+                    })];
             });
         });
     };
@@ -190,7 +210,9 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                     validityType: validityType
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/search?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.subscriptions;
+                    })];
             });
         });
     };
@@ -215,14 +237,16 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                     validityType: request.validityType
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/availabilities?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url)];
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
             });
         });
     };
     /**
      * This method creates a subscription cart for the given parameters.
      * @param {CreateSubscriptionCartRequest} request the request object containing the parameters for the availability check
-     * @returns
+     * @returns {SubscriptionCart} The created cart
      */
     SubscriptionBooking.prototype.createSubscriptionCart = function (request) {
         return __awaiter(this, void 0, void 0, function () {
@@ -230,12 +254,127 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             var _this = this;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions");
-                return [2 /*return*/, this.callPostApi(url, request).then(function (cart) {
-                        _this.cart = cart.cart;
-                        _this.cartStatus = cart.cart.status;
-                        _this.bookingDueDate = new Date(cart.cart.bookingDueDate);
-                        _this.createCartTimer(new Date(cart.cart.bookingDueDate));
-                        return cart.cart;
+                return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
+                        // Check for errors
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        _this.cart = response.cart;
+                        // Save the cartId in the localStorage
+                        localStorage.setItem("cartId", response.cart.id.toString());
+                        // Fill the booking process status
+                        _this.bookingStepsToStatus = new Map(Object.entries(response.cart.stepsToStatus).map(function (_a) {
+                            var bookingStep = _a[0], values = _a[1];
+                            return [
+                                bookingStep,
+                                values
+                            ];
+                        }));
+                        _this.bookingDueDate = new Date(response.cart.bookingDueDate);
+                        _this.createCartTimer(new Date(response.cart.bookingDueDate));
+                        return response.cart;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be called when the user wants to retrieve information about the buyer and the passengers.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    SubscriptionBooking.prototype.getBuyerPassengersDetails = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/details?");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        // Check for errors
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        // Parse the map for the tariffs
+                        var tripsToTariffs = new Map(Object.entries(response.tariffs).map(function (_a) {
+                            var tripId = _a[0], tariff = _a[1];
+                            return [
+                                +tripId,
+                                tariff
+                            ];
+                        }));
+                        return {
+                            buyer: response.buyer,
+                            passengers: response.passengers,
+                            tariffs: tripsToTariffs
+                        };
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be called when the user wants to retrieve information about an esisting buyer.
+     * @param {string} [linkavelCardNumber=undefined] The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * A linkavelCardNumber is a string of 9 digits.
+     * @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    SubscriptionBooking.prototype.getBuyer = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, searchParams, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                if (!linkavelCardNumber && !linkavelCardPhoneNumber) {
+                    throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
+                }
+                searchParams = new URLSearchParams({
+                    linkavelCardNumber: linkavelCardNumber !== null && linkavelCardNumber !== void 0 ? linkavelCardNumber : "",
+                    linkavelCardPhoneNumber: linkavelCardPhoneNumber !== null && linkavelCardPhoneNumber !== void 0 ? linkavelCardPhoneNumber : "",
+                });
+                url = "".concat(this.config.API_ENDPOINT, "/buyers?").concat(searchParams, "}");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        // Check for errors
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        return response.buyers[0];
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This methosd shall be called when the user wants to update the buyer and the passengers information.
+     * @param {EditPassengersDetailsRequest} passengersDetails The object containing the buyer and the passengers information.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    SubscriptionBooking.prototype.updateBuyerPassengersDetails = function (passengersDetails) {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/details");
+                return [2 /*return*/, this.callPostApi(url, passengersDetails).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
                     })];
             });
         });

package/lib/index.d.ts

@@ -2,9 +2,13 @@ export { Booking } from "./booking/booking";
 export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
-export { Person, PassengersDetails, DEFAULT_PERSON } from "./types/common/Person";
-export { Tariff, TariffsMatrix, TariffSummary, TariffType, TermsType } from "./types/common/Tariffs";
+export { Person, DEFAULT_PERSON, initializePerson } from "./types/common/Person";
+export { EditPassengerRequestType, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "./types/common/Person";
+export { Tariff, TariffsMatrix, TariffSummary, TariffType, TermsType, PassengerTariff, ExtraTariff } from "./types/common/Tariffs";
+export { Reduction, AddReductionRequest } from "./types/common/Reduction";
+export { Gateway, GetSellerGatewaysResponse, GetPaymentInformationFromGatewayResponse, GatewayTypes, PaymentMethods } from "./types/common/Payment";
 export { ErrorResponse } from "./types/ErrorResponse";
+export { BusLayoutCell, BusMatrix, BusCellTypes, SeatStatus } from "./types/journeys/BusMatrix";
 export { JourneyCart, JourneyBookingType, CreateJourneyCartRequest, TripBookingInfo, DEFAULT_CREATE_JOURNEY_CART } from "./types/journeys/JourneyCart";
 export { JourneyInfo } from "./types/journeys/JourneyInfo";
 export { JourneySearchRequest, JourneySearchResult, DEFAULT_JOURNEY_SEARCH } from "./types/journeys/JourneySearch";

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_CREATE_JOURNEY_CART = exports.DEFAULT_PERSON = exports.SubscriptionBooking = exports.ServiceBooking = exports.JourneyBooking = exports.Booking = void 0;
+exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_CREATE_JOURNEY_CART = exports.SeatStatus = exports.BusCellTypes = exports.PaymentMethods = exports.GatewayTypes = exports.initializePerson = exports.DEFAULT_PERSON = exports.SubscriptionBooking = exports.ServiceBooking = exports.JourneyBooking = exports.Booking = void 0;
 //#region Export Booking classes
 var booking_1 = require("./booking/booking");
 Object.defineProperty(exports, "Booking", { enumerable: true, get: function () { return booking_1.Booking; } });
@@ -15,9 +15,15 @@ Object.defineProperty(exports, "SubscriptionBooking", { enumerable: true, get: f
 // @note: Cart is not exported because it is extended by other types
 var Person_1 = require("./types/common/Person");
 Object.defineProperty(exports, "DEFAULT_PERSON", { enumerable: true, get: function () { return Person_1.DEFAULT_PERSON; } });
+Object.defineProperty(exports, "initializePerson", { enumerable: true, get: function () { return Person_1.initializePerson; } });
+var Payment_1 = require("./types/common/Payment");
+Object.defineProperty(exports, "GatewayTypes", { enumerable: true, get: function () { return Payment_1.GatewayTypes; } });
+Object.defineProperty(exports, "PaymentMethods", { enumerable: true, get: function () { return Payment_1.PaymentMethods; } });
 //#endregion
 //#region Export JourneyBooking types
-// TODO: BusMatrix.ts
+var BusMatrix_1 = require("./types/journeys/BusMatrix");
+Object.defineProperty(exports, "BusCellTypes", { enumerable: true, get: function () { return BusMatrix_1.BusCellTypes; } });
+Object.defineProperty(exports, "SeatStatus", { enumerable: true, get: function () { return BusMatrix_1.SeatStatus; } });
 var JourneyCart_1 = require("./types/journeys/JourneyCart");
 Object.defineProperty(exports, "DEFAULT_CREATE_JOURNEY_CART", { enumerable: true, get: function () { return JourneyCart_1.DEFAULT_CREATE_JOURNEY_CART; } });
 var JourneySearch_1 = require("./types/journeys/JourneySearch");

package/lib/types/ErrorResponse.d.ts

@@ -10,3 +10,4 @@ export type ErrorResponse = {
     mtsCode: number;
     message: string;
 };
+export declare const objectIsMTSErrorResponse: (error: any) => boolean;

package/lib/types/ErrorResponse.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectIsMTSErrorResponse = void 0;
+var objectIsMTSErrorResponse = function (error) {
+    return "mtsCode" in error && "httpStatus" in error && "message" in error;
+};
+exports.objectIsMTSErrorResponse = objectIsMTSErrorResponse;

package/lib/types/common/Cart.d.ts

@@ -1,14 +1,20 @@
 import { Booking } from "../../booking/booking";
+import { Reduction } from "./Reduction";
+import { Extra } from "./Extra";
 /**
  * @description Cart is the object returned by the API when a cart is created.
  * Note that depending on the type of booking, this type will be extended with different fields:
- * - TourCart: {@link TourCart.ts}
- * - JourneyCart: {@link JourneyCart.ts}
- * - SubscriptionCart: {@link SubscriptionCart.ts}
+ * - TourCart: {@link ServiceCart}
+ * - JourneyCart: {@link JourneyCart}
+ * - SubscriptionCart: {@link SubscriptionCart}
  * @property {number} id The id of the cart
  * @property {string} cartCode The code of the cart
- * @property {Booking.CartStatus} status The status of the cart. See {@link Booking.CartStatus}
- * @property {Booking.CartStatus} nextStatus The next status of the cart. See {@link Booking.CartStatus}
+ * @property {Map<string, boolean[]>} stepsToStatus This data structure describes the steps of the booking process.
+ * The keys of this dictionary represent the booking steps. See ... for the list of possible steps. If the
+ * key is present, then the booking step shall be displayed. The value is a list of 3 booleans:
+ * - The first tells whether it is possible to go to that section. If not, other sections must be completed first.
+ * - The second tells whether the section is completed.
+ * - The third tells whether the section is required.
  * @property {Booking.Currencies} currency The currency of the cart. See {@link Booking.Currencies}
  * @property {string} bookingDueDate The date and time when the cart expires
  * @property {number} buyerId The id of the buyer
@@ -16,33 +22,15 @@ import { Booking } from "../../booking/booking";
 export type Cart = {
     id: number;
     cartCode: string;
-    status: Booking.CartStatus;
-    nextStatus: Booking.CartStatus;
+    stepsToStatus: Map<string, boolean[]>;
     currency: Booking.Currencies;
     bookingDueDate: string;
     buyerId: number;
-    reductions: {
-        tripId: number;
-        tripName: string;
-        value: number;
-        isPercentage: boolean;
-        voucherCode?: string;
-    }[];
-    isSeatsSelectionAllowed: boolean;
+    reductions: Reduction[];
     sellingMethod: string;
     totalValue: number;
     totalResellerFee?: number;
     totalCreditFromChange: number;
     totalAmountToPay: number;
-    extas: {
-        id: number;
-        resourceId: number;
-        name: string;
-        description: string;
-        notes: string;
-        tariff: {
-            tariffId: number;
-            tariffName: string;
-        };
-    }[];
+    extras: Extra[];
 };

package/lib/types/common/Extra.d.ts

@@ -0,0 +1,20 @@
+import { ExtraTariff } from "./Tariffs";
+/**
+ * @description this type represents an extra, which is an additional service that can be added to a cart. Extras are selected in the booking step `EXTRAS`.
+ *
+ * @property {number} id The id of the extra
+ * @property {number} resourceId The id of a resource associated with this extra, for description purposes.
+ * Could the be the id of an image, text or HTML that the seller wants to display to the customer.
+ * @property {string} name The name of the extra
+ * @property {string} description The description of the extra
+ * @property {string} notes Some notes about the extra
+ * @property {ExtraTariff} tariff The tariff at which the extra was sold
+ */
+export type Extra = {
+    id: number;
+    resourceId: number;
+    name: string;
+    description: string;
+    notes: string;
+    tariff: ExtraTariff;
+};

package/lib/types/common/Extra.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/common/Payment.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @description This type represents a payment method available for the cart
+ * @param {number} id The id of the payment method
+ * @param {GatewayTypes} type The type of the payment method
+ * @param {string} name The name of the payment method, to be displayed to the user
+ */
+export type Gateway = {
+    id: number;
+    type: GatewayTypes;
+    name: string;
+};
+/**
+ * @description This type represents the response of the {@link Booking.getSellerGateways} API. Note that at least
+ * one of the two fields will be null, depending on the seller configuration.
+ * @param {Gateway | null} cardGatewayDTO The card gateway, if available. Currecntly this can only be {@link GatewayTypes.AXEPTA_BNL}
+ * or {@link GatewayTypes.AXERVE_BANCASELLA}
+ * @param {Gateway | null} payPalGatewayDTO The PayPal gateway, if available.
+ */
+export type GetSellerGatewaysResponse = {
+    cardGatewayDTO: Gateway | null;
+    payPalGatewayDTO: Gateway | null;
+};
+/**
+ * @description This type represents the response of the {@link Booking.getPaymentInformationFromGateway} API.
+ * Note that only the fields of the chosen gateway will be populated.
+ * @param {string | null} axervE_BANCASELLA_PaymentId The payment id of the Axerve Bancasella gateway
+ * @param {string | null} axervE_BANCASELLA_PaymentToken The payment token of the Axerve Bancasella gateway
+ * @param {string | null} axervE_BANCASELLA_ShopLogin The shop login of the Axerve Bancasella gateway
+ * @param {string | null} axeptA_BNL_PaymentId The payment id of the Axepta BNL gateway
+ * @param {string | null} axeptA_BNL_SmartLicenseKey The smart license key of the Axepta BNL gateway
+ * @param {string | null} paypaL_ClientId The client id of the PayPal gateway
+ * @param {string | null} paypaL_OrderId The order id of the PayPal gateway
+ * @param {string | null} paypaL_Link The link of the PayPal gateway
+ */
+export type GetPaymentInformationFromGatewayResponse = {
+    axervE_BANCASELLA_PaymentId: string | null;
+    axervE_BANCASELLA_PaymentToken: string | null;
+    axervE_BANCASELLA_ShopLogin: string | null;
+    axeptA_BNL_PaymentId: string | null;
+    axeptA_BNL_SmartLicenseKey: string | null;
+    paypaL_ClientId: string | null;
+    paypaL_OrderId: string | null;
+    paypaL_Link: string | null;
+};
+/**
+ * @description This enum contains the possible values for the `type` field of the {@link Gateway} type
+ */
+export declare enum GatewayTypes {
+    AXEPTA_BNL = "AXEPTA_BNL",
+    AXERVE_BANCASELLA = "AXERVE_BANCASELLA",
+    PAYPAL = "PAYPAL"
+}
+/**
+ * @description This enum contains the possible values for the `paymentMethod` parameter of the {@link Booking.issueTickets} function.
+ */
+export declare enum PaymentMethods {
+    CARD = "CARD",
+    CASH = "CASH",
+    CREDIT_FROM_CHANGE = "CREDIT_FROM_CHANGE",
+    PAY_LATER = "PAY_LATER",
+    ONLINE_CARD = "ONLINE CARD",
+    WALLET = "WALLET"
+}

package/lib/types/common/Payment.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethods = exports.GatewayTypes = void 0;
+/**
+ * @description This enum contains the possible values for the `type` field of the {@link Gateway} type
+ */
+var GatewayTypes;
+(function (GatewayTypes) {
+    GatewayTypes["AXEPTA_BNL"] = "AXEPTA_BNL";
+    GatewayTypes["AXERVE_BANCASELLA"] = "AXERVE_BANCASELLA";
+    GatewayTypes["PAYPAL"] = "PAYPAL";
+})(GatewayTypes || (exports.GatewayTypes = GatewayTypes = {}));
+/**
+ * @description This enum contains the possible values for the `paymentMethod` parameter of the {@link Booking.issueTickets} function.
+ */
+var PaymentMethods;
+(function (PaymentMethods) {
+    PaymentMethods["CARD"] = "CARD";
+    PaymentMethods["CASH"] = "CASH";
+    PaymentMethods["CREDIT_FROM_CHANGE"] = "CREDIT_FROM_CHANGE";
+    PaymentMethods["PAY_LATER"] = "PAY_LATER";
+    PaymentMethods["ONLINE_CARD"] = "ONLINE CARD";
+    PaymentMethods["WALLET"] = "WALLET";
+})(PaymentMethods || (exports.PaymentMethods = PaymentMethods = {}));

package/lib/types/common/Person.d.ts

@@ -1,3 +1,4 @@
+import { PassengerTariff } from "./Tariffs";
 /**
  * @description Represents a person, that can be a passenger or the buyer.
  *
@@ -6,6 +7,7 @@
  * @property {string} lastName - The last name of the person.
  * @property {string} email - The email of the person.
  * @property {string} phoneNumber - The phone number of the person.
+ * @property {string} [notes=undefined] - The notes for this person.
  */
 export type Person = {
     id: number;
@@ -13,19 +15,39 @@ export type Person = {
     lastName: string;
     email: string;
     phoneNumber: string;
+    notes?: string;
 };
 export declare const DEFAULT_PERSON: Person;
+export declare const initializePerson: (person?: Person | undefined | null) => Person;
 /**
- * @description Represents the passengers details.
+ * @description Represents the response of the {@link getBuyerPassengersDetails} method.
  *
- * @property {Person[]} passengers - An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers.
  * @property {Person} buyer - The {@link Person} object representing the buyer.
+ * @property {Person[]} passengers - An array of {@link Person} objects representing the passengers.
+ * @property {Map<number, PassengerTariff>} tariffs - A map from the trip id to the {@link PassengerTariff} object,
+ * representing the available tariffs for that trip (from the ones chosen by the user when creating the cart).
+ */
+export type GetBuyerPassengersDetailsResponse = {
+    buyer: Person;
+    passengers: Person[];
+    tariffs: Map<number, PassengerTariff>;
+};
+/**
+ * @description Represents the type of the passengers array in {@link EditPassengersDetailsRequest}.
  */
-export type PassengersDetails = {
-    passengers: Person[] & {
-        tripsToTariffs: {
-            [tripId: number]: number;
-        };
+export type EditPassengerRequestType = Person & {
+    tripsToTariffs: {
+        [tripId: number]: number;
     };
+};
+/**
+ * @description Represents the passengers details.
+ * This type shall be used as request for the {@link updatePassengersDetails} method.
+ *
+ * @property {EditPassengerRequestType[]} passengers - An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers.
+ * @property {Person} buyer - The {@link Person} object representing the buyer.
+ */
+export type EditPassengersDetailsRequest = {
+    passengers: EditPassengerRequestType[];
     buyer: Person;
 };

package/lib/types/common/Person.js

@@ -1,7 +1,7 @@
 "use strict";
 // This module contains the types to manage the passengers information
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_PERSON = void 0;
+exports.initializePerson = exports.DEFAULT_PERSON = void 0;
 exports.DEFAULT_PERSON = {
     id: 0,
     name: '',
@@ -9,3 +9,10 @@ exports.DEFAULT_PERSON = {
     email: '',
     phoneNumber: ''
 };
+var initializePerson = function (person) {
+    if (!person) {
+        return exports.DEFAULT_PERSON;
+    }
+    return person;
+};
+exports.initializePerson = initializePerson;

package/lib/types/common/Reduction.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @description This type represents a reduction applied to the cart. Reductions are applied in the booking step `DISCOUNTS`.
+ *
+ * @property {number} tripId The id of the trip to which the reduction is applied
+ * @property {string} tripName The name of the trip to which the reduction is applied
+ * @property {number} value The value of the reduction
+ * @property {boolean} isPercentage If true, the reduction is a percentage. In this case, it is a number from 0 to 1.
+ * Otherwise, it is in the currency of the cart.
+ * @property {string} [voucherCode=undefined] The voucher code used to apply the reduction
+ */
+export type Reduction = {
+    tripId: number;
+    tripName: string;
+    value: number;
+    isPercentage: boolean;
+    voucherCode?: string;
+};
+/**
+ * @description This type represents a request to add a reduction to the cart
+ *
+ * @property {number} tripId The id of the trip to which the reduction is applied. If the tripId is 0,
+ * then the reduction will be applied to the whole cart
+ * @property {number} reduction The value of the reduction
+ * @property {boolean} isPercentage If true, the reduction is a percentage. In this case, it is a number from 0 to 1.
+ * Otherwise, it is in the currency of the cart (the value must be greater than 0)
+ */
+export type AddReductionRequest = {
+    tripId: number;
+    reduction: number;
+    isPercentage: boolean;
+};

package/lib/types/common/Reduction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/common/Tariffs.d.ts

@@ -55,3 +55,24 @@ export type TariffSummary = {
     label: string;
     value: number;
 };
+/**
+ * @description This type represent a tariff on a particular trip. It shall be used for selecting the tariffs
+ * of the passenger (in the passenger details page).
+ *
+ * @property {number} id The id of the tariff
+ * @property {string} tariffName The name of the tariff
+ */
+export type PassengerTariff = {
+    id: number;
+    tariffName: string;
+};
+/**
+ * @description This type represents the tariff at which the extra was sold.
+ *
+ * @property {number} tariffId The id of the tariff
+ * @property {string} tariffName The name of the tariff
+ */
+export type ExtraTariff = {
+    tariffId: number;
+    tariffName: string;
+};

package/lib/types/journeys/BusMatrix.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This represents a a bus layout cell, a part of a {@link BusMatrix}.
+ * @param {number} id - The id of bus layout cell.
+ * @param {BusCellTypes} type - The id of the bus layout cell. It shall be used to select what to display when rendering the bus layout.
+ * @param {string} label - The label to display on the seat (e.g. 8A)
+ * @param {SeatStatus} status - The status of the seat.
+ */
+export type BusLayoutCell = {
+    id: number;
+    type: BusCellTypes;
+    label: string;
+    status: SeatStatus;
+};
+/**
+ * This represents a tariff matrix. It is a 3D array of {@link BusLayoutCell} objects.
+ * - On the first dimension, there is the floor of the bus.
+ * - On the second dimentsion, there are the rows.
+ * - On the third dimension, the are the columns.
+ */
+export type BusMatrix = BusLayoutCell[][][];
+export declare enum BusCellTypes {
+    SEAT = "SEAT",
+    SELECTED_SEAT = "SELECTED_SEAT",
+    DRIVER = "DRIVER",
+    WC = "WC",
+    EXIT = "EXIT",
+    TABLE = "TABLE",
+    STAIRS = "STAIRS"
+}
+export declare enum SeatStatus {
+    RESERVED = "RESERVED",
+    AVAILABLE = "AVAILABLE",
+    OCCUPIED = "OCCUPIED"
+}