mts-booking-library 1.1.10 → 1.2.1

package/lib/booking/booking.d.ts

@@ -1,4 +1,7 @@
 import { MTSConfig, MTSEnvs } from "../config";
+import { ErrorResponse } from "../types/ErrorResponse";
+import { GetPaymentInformationFromGatewayResponse, GetSellerGatewaysResponse, PaymentMethods } from "../types/common/Payment";
+import { AddReductionRequest } from "../types/common/Reduction";
 export declare abstract class Booking {
     readonly sellerId?: number | undefined;
     readonly resellerId?: number | undefined;
@@ -6,7 +9,16 @@ export declare abstract class Booking {
     readonly config: MTSConfig;
     language: string;
     selectedCurrency: Booking.Currencies;
-    cartStatus: Booking.CartStatus;
+    /**
+     * This map describes the status of the booking steps. The keys of this dictionary represent the booking steps.
+     * If the key is present, then the booking step shall be displayed. See {@link Booking.BookingSteps} for the possible values.
+     * The value is a list of 3 booleans: <br/>
+     * - The first tells whether it is possible to go to that section. <br/>
+     * - The second tells whether the section is completed. <br/>
+     * - The third tells whether the section is required. <br/>
+     */
+    bookingStepsToStatus: Map<string, boolean[]>;
+    cartId: number | undefined;
     bookingDueDate: Date | undefined;
     onCartExpiration: () => void;
     /**
@@ -26,12 +38,51 @@ export declare abstract class Booking {
      * @param {string} access_token The new access token
      */
     renewAccessToken(access_token: string): void;
-    callGetApi(url: string): Promise<any>;
+    callGetApi(url: string): Promise<ErrorResponse | any>;
     callPostApi(url: string, body: any): Promise<any>;
-    getCartStatus(): Booking.CartStatus;
+    getBookingStepsToStatus(): Map<string, boolean[]>;
     changeCurrency(currency: Booking.Currencies): void;
     changeLanguage(language: string): void;
     getCartExpirationTimeInMs(): Promise<number>;
+    /**
+     * @description This method allows to add a reduction to the cart
+     * @param {AddReductionRequest} request The information about the reduction to add
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    addReduction(request: AddReductionRequest): Promise<ErrorResponse | any>;
+    /**
+     * @description This method allows the user to use the balance in his wallet to pay the cart. If the balance of
+     * the wallet is enough to pay the cart, the cart will be paid fully. Otherwise, the user will be asked to pay the
+     * remaining amount with another payment method.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    useWallet(): Promise<ErrorResponse | any>;
+    /**
+     * @description This method allows the user to use a voucher to pay the cart.
+     * If the balance of the value of the voucher is enough to pay the cart, the cart will be paid fully.
+     * Otherwise, the user will be asked to pay the remaining amount with another payment method.
+     * @param {string} voucherCode The code of the voucher to use
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    useVoucher(voucherCode: string): Promise<ErrorResponse | any>;
+    /**
+     * @description This method shall be used to get the available payment methods for the cart. They depend on the seller configuration.
+     * @returns An {@link ErrorResponse} object in case of error, a {@link GetSellerGatewaysResponse} object otherwise.
+     */
+    getSellerGateways(): Promise<ErrorResponse | GetSellerGatewaysResponse>;
+    /**
+     * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
+     * @param {number} gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
+     * @param {string} [returnUrl=undefined] The url to which the user will be redirected after the payment. This value shall be set only if the
+     * chosen gateway is {@link GatewayTypes.PAYPAL}
+     * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
+     */
+    getPaymentInformationFromGateway(gatewayId: number, returnUrl?: string): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
+    /**
+     * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    issueTickets(paymentMethod: PaymentMethods): Promise<ErrorResponse | any>;
 }
 export declare namespace Booking {
     enum Currencies {
@@ -46,13 +97,13 @@ export declare namespace Booking {
         DE = "de",
         ES = "es"
     }
-    enum CartStatus {
-        EMPTY = "EMPTY",
-        CREATION = "CREATION",
-        PASSENGERS = "PASSENGERS",
-        SEATS = "SEATS",
-        EXTRAS = "EXTRAS",
-        PAYMENT = "PAYMENT"
+    enum BookingSteps {
+        SEARCH = "BOOKING_STEP_SEARCH",
+        BUYER_PASSENGERS = "BOOKING_STEP_BUYER_PASSENGERS",
+        SEATS_SELECTION = "BOOKING_STEP_SEATS_SELECTION",
+        EXTRAS = "BOOKING_STEP_EXTRAS",
+        DISCOUNTS = "BOOKING_STEP_DISCOUNTS",
+        ISSUE = "BOOKING_STEP_ISSUE"
     }
     enum BookingTypes {
         MLP = "MLP",

package/lib/booking/booking.js

@@ -49,6 +49,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Booking = void 0;
 var config_1 = require("../config");
+var ErrorResponse_1 = require("../types/ErrorResponse");
+var Payment_1 = require("../types/common/Payment");
 var apiCall_1 = require("../utils/apiCall");
 var Booking = /** @class */ (function () {
     /**
@@ -67,7 +69,15 @@ var Booking = /** @class */ (function () {
         if (language === void 0) { language = Booking.Languages.EN; }
         this.language = Booking.Languages.EN;
         this.selectedCurrency = Booking.Currencies.EUR;
-        this.cartStatus = Booking.CartStatus.EMPTY;
+        /**
+         * This map describes the status of the booking steps. The keys of this dictionary represent the booking steps.
+         * If the key is present, then the booking step shall be displayed. See {@link Booking.BookingSteps} for the possible values.
+         * The value is a list of 3 booleans: <br/>
+         * - The first tells whether it is possible to go to that section. <br/>
+         * - The second tells whether the section is completed. <br/>
+         * - The third tells whether the section is required. <br/>
+         */
+        this.bookingStepsToStatus = new Map();
         this.sellerId = sellerId || undefined;
         this.resellerId = resellerId || undefined;
         this.config = (0, config_1.setConfig)(env, sub_key, debug);
@@ -94,8 +104,8 @@ var Booking = /** @class */ (function () {
         var completeBody = __assign(__assign(__assign(__assign({}, body), (this.sellerId && { sellerId: this.sellerId.toString() })), (this.resellerId && { resellerId: this.resellerId.toString() })), { language: this.language });
         return (0, apiCall_1.makePost)(url, completeBody);
     };
-    Booking.prototype.getCartStatus = function () {
-        return this.cartStatus;
+    Booking.prototype.getBookingStepsToStatus = function () {
+        return this.bookingStepsToStatus;
     };
     Booking.prototype.changeCurrency = function (currency) {
         this.selectedCurrency = currency;
@@ -123,6 +133,158 @@ var Booking = /** @class */ (function () {
             });
         });
     };
+    /**
+     * @description This method allows to add a reduction to the cart
+     * @param {AddReductionRequest} request The information about the reduction to add
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    Booking.prototype.addReduction = function (request) {
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                discountsStep = this.bookingStepsToStatus.get(Booking.BookingSteps.DISCOUNTS);
+                if (!discountsStep || !discountsStep[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.cartId, "/reduction");
+                return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method allows the user to use the balance in his wallet to pay the cart. If the balance of
+     * the wallet is enough to pay the cart, the cart will be paid fully. Otherwise, the user will be asked to pay the
+     * remaining amount with another payment method.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    Booking.prototype.useWallet = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                discountsStep = this.bookingStepsToStatus.get(Booking.BookingSteps.DISCOUNTS);
+                if (!discountsStep || !discountsStep[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.cartId, "/payment/wallet");
+                return [2 /*return*/, this.callPostApi(url, {}).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method allows the user to use a voucher to pay the cart.
+     * If the balance of the value of the voucher is enough to pay the cart, the cart will be paid fully.
+     * Otherwise, the user will be asked to pay the remaining amount with another payment method.
+     * @param {string} voucherCode The code of the voucher to use
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    Booking.prototype.useVoucher = function (voucherCode) {
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                discountsStep = this.bookingStepsToStatus.get(Booking.BookingSteps.DISCOUNTS);
+                if (!discountsStep || !discountsStep[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.cartId, "/payment/voucher");
+                return [2 /*return*/, this.callPostApi(url, { voucherCode: voucherCode }).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be used to get the available payment methods for the cart. They depend on the seller configuration.
+     * @returns An {@link ErrorResponse} object in case of error, a {@link GetSellerGatewaysResponse} object otherwise.
+     */
+    Booking.prototype.getSellerGateways = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var issueStep, url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                issueStep = this.bookingStepsToStatus.get(Booking.BookingSteps.ISSUE);
+                if (!issueStep || !issueStep[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/sellers/").concat(this.sellerId, "/gateways");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
+     * @param {number} gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
+     * @param {string} [returnUrl=undefined] The url to which the user will be redirected after the payment. This value shall be set only if the
+     * chosen gateway is {@link GatewayTypes.PAYPAL}
+     * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
+     */
+    Booking.prototype.getPaymentInformationFromGateway = function (gatewayId, returnUrl) {
+        return __awaiter(this, void 0, void 0, function () {
+            var issueStep, url, body;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                issueStep = this.bookingStepsToStatus.get(Booking.BookingSteps.ISSUE);
+                if (!issueStep || !issueStep[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/getPaymentInformationFromGateway");
+                body = __assign({ cartId: this.cartId, gatewayId: gatewayId }, (returnUrl && { returnUrl: returnUrl }));
+                return [2 /*return*/, this.callPostApi(url, body).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    Booking.prototype.issueTickets = function (paymentMethod) {
+        return __awaiter(this, void 0, void 0, function () {
+            var issueStep, url, body;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                issueStep = this.bookingStepsToStatus.get(Booking.BookingSteps.ISSUE);
+                if (!issueStep || !issueStep[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/issueTickets");
+                body = {
+                    cartId: this.cartId,
+                    paymentMethod: paymentMethod === Payment_1.PaymentMethods.PAY_LATER ? null : paymentMethod,
+                };
+                return [2 /*return*/, this.callPostApi(url, body).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
     return Booking;
 }());
 exports.Booking = Booking;
@@ -141,15 +303,15 @@ exports.Booking = Booking;
         Languages["DE"] = "de";
         Languages["ES"] = "es";
     })(Languages = Booking.Languages || (Booking.Languages = {}));
-    var CartStatus;
-    (function (CartStatus) {
-        CartStatus["EMPTY"] = "EMPTY";
-        CartStatus["CREATION"] = "CREATION";
-        CartStatus["PASSENGERS"] = "PASSENGERS";
-        CartStatus["SEATS"] = "SEATS";
-        CartStatus["EXTRAS"] = "EXTRAS";
-        CartStatus["PAYMENT"] = "PAYMENT";
-    })(CartStatus = Booking.CartStatus || (Booking.CartStatus = {}));
+    var BookingSteps;
+    (function (BookingSteps) {
+        BookingSteps["SEARCH"] = "BOOKING_STEP_SEARCH";
+        BookingSteps["BUYER_PASSENGERS"] = "BOOKING_STEP_BUYER_PASSENGERS";
+        BookingSteps["SEATS_SELECTION"] = "BOOKING_STEP_SEATS_SELECTION";
+        BookingSteps["EXTRAS"] = "BOOKING_STEP_EXTRAS";
+        BookingSteps["DISCOUNTS"] = "BOOKING_STEP_DISCOUNTS";
+        BookingSteps["ISSUE"] = "BOOKING_STEP_ISSUE";
+    })(BookingSteps = Booking.BookingSteps || (Booking.BookingSteps = {}));
     var BookingTypes;
     (function (BookingTypes) {
         BookingTypes["MLP"] = "MLP";

package/lib/booking/journeyBooking.d.ts

@@ -1,5 +1,7 @@
 import { MTSEnvs } from "../config";
-import { PassengersDetails } from "../types/common/Person";
+import { ErrorResponse } from "../types/ErrorResponse";
+import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { BusMatrix } from "../types/journeys/BusMatrix";
 import { CreateJourneyCartRequest, JourneyCart } from "../types/journeys/JourneyCart";
 import { JourneySearchRequest, JourneySearchResult } from "../types/journeys/JourneySearch";
 import { Booking } from "./booking";
@@ -25,32 +27,63 @@ export declare class JourneyBooking extends Booking {
     * This method returns the possible departures for all journeys (MLP) sold by this seller.
     * @returns {string[]} The list of possible departures
     */
-    getJourneysDepartures(): Promise<string[]>;
+    getJourneysDepartures(): Promise<ErrorResponse | string[]>;
     /**
     * This method returns the possible destination for the journeys sold by this seller that start at the selected departure.
     * @param {string} departureStopName The departure stop name (as returned by {@link getJourneysDepartures})
     * @returns {string[]} The list of possible destinations
     */
-    getJourneysDestinations(departureStopName: string): Promise<string[]>;
+    getJourneysDestinations(departureStopName: string): Promise<ErrorResponse | string[]>;
     /**
     * This method returns the journeys that match the given parameters.
     * Note that it will always return the journeys for the one-way trip.
     * If you want to get the journeys for the round trip, you have to call this method twice (make sure to swap departureStopName and destinationStopName)
-    * @param {JourneySearch} params an object of type {@link JourneySearch} containing the parameters of the search
+    * @param {JourneySearch} request an object of type {@link JourneySearch} containing the parameters of the search
     * @returns {JourneySearchResult[]} The returned journeys that match the given parameters
     */
-    getJourneys(params: JourneySearchRequest): Promise<JourneySearchResult[]>;
-    createJourneyCart(tripCart: CreateJourneyCartRequest): Promise<JourneyCart>;
-    getBusMatrix(tripId: number, departureStopId: number, destinationStopId: number): Promise<any>;
-    getSeatsStatus(params: {
-        tripId: number;
-        departureStopId: number;
-        destinationStopId: number;
-    }): Promise<any>;
-    movePassengers(params: {
-        tripId: number;
-        seatsIds: number[];
-    }): Promise<any>;
-    getPassengersDetails(): Promise<any>;
-    updatePassengersDetails(passengersDetails: PassengersDetails): Promise<any>;
+    getJourneys(request: JourneySearchRequest): Promise<ErrorResponse | JourneySearchResult[]>;
+    createJourneyCart(journeyCart: CreateJourneyCartRequest): Promise<ErrorResponse | JourneyCart>;
+    /**
+     * @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.
+     */
+    getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
+    /**
+     * @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.
+     */
+    getBuyer(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    /**
+     * @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.
+     */
+    updateBuyerPassengersDetails(passengersDetails: EditPassengersDetailsRequest): Promise<ErrorResponse | any>;
+    /**
+     * @description This method shall be used when the user wants to retrieve the bus matrix for a trip. The bus matrix shows
+     * the seats that are available and the ones that are already taken, as well as how the bus is made.
+     * @param {number} tripId The id of the trip for which the bus matrix should be retrieved
+     * @param {number} departureStopId The id of the departure stop
+     * @param {number} destinationStopId The id of the destination stop
+     * @returns An {@link ErrorResponse} object in case of error, a {@link BusMatrix} otherwise.
+     */
+    getBusMatrix(tripId: number, departureStopId: number, destinationStopId: number): Promise<ErrorResponse | BusMatrix>;
+    /**
+     * @description This method shall be called when the user wants to retrieve which seats were assigned for this booking.
+     * @param {number} tripId The id of the trip for which the seats should be retrieved.
+     * @returns An {@link ErrorResponse} object in case of error, a list of {@link BusLayoutCell} ids otherwise, representing the assigned seats.
+     */
+    getAssignedSeats(tripId: number): Promise<ErrorResponse | number[]>;
+    /**
+     * @description This method shall be called when the user wants to change the assigned seats of a trip.
+     * @param {number} tripId The id of the trip for which the seats should be changed
+     * @param {number[]} newSeatsIds The ids of the new seats, as found the {@link BusMatrix}
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     */
+    changeSeatsOfTrip(tripId: number, newSeatsIds: number[]): Promise<ErrorResponse | any>;
 }