mts-booking-library 2.0.0 → 2.1.0

package/lib/booking/serviceBooking.js

@@ -130,12 +130,12 @@ var ServiceBooking = /** @class */ (function (_super) {
             console.log(e);
         }
     };
-    ServiceBooking.prototype.fetchAndSetCart = function (cartGuid) {
+    ServiceBooking.prototype.fetchAndSetCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetchCart(cartGuid).then(function (cart) {
+                    case 0: return [4 /*yield*/, this.fetchCart(cartGuid, options).then(function (cart) {
                             if (cart) {
                                 var cartDueDate = new Date();
                                 cartDueDate.setSeconds(cartDueDate.getSeconds() + cart.bookingDueDateRemainingSeconds);
@@ -161,13 +161,13 @@ var ServiceBooking = /** @class */ (function (_super) {
             });
         });
     };
-    ServiceBooking.prototype.fetchCart = function (cartGuid) {
+    ServiceBooking.prototype.fetchCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             var _this = this;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts?").concat(new URLSearchParams({ cartGuid: cartGuid }));
-                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                             _this.resetBooking();
                             throw new Error(JSON.stringify(response, null, 2));
@@ -186,7 +186,7 @@ var ServiceBooking = /** @class */ (function (_super) {
      * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
      * data will be deleted.
      */
-    ServiceBooking.prototype.deleteCart = function () {
+    ServiceBooking.prototype.deleteCart = function (options) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             var _this = this;
@@ -196,7 +196,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                     throw Error("Cart is not initialized yet");
                 }
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts?").concat(new URLSearchParams({ cartGuid: this.cart.guid }));
-                return [2 /*return*/, this.callDeleteApi(url).then(function (response) {
+                return [2 /*return*/, this.callDeleteApi(url, options).then(function (response) {
                         // Clear all data
                         _this.resetBooking();
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
@@ -207,14 +207,14 @@ var ServiceBooking = /** @class */ (function (_super) {
     /**
      * This method returns the list of cities in which the seller offers tours.
      * If the sellerId is not set or it is 0, it will return the list of cities for all sellers.
-     * @returns {string[]} The list of possible cities
+     * @returns The list of possible cities
      */
-    ServiceBooking.prototype.getServiceCities = function () {
+    ServiceBooking.prototype.getServiceCities = function (options) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/services/cities?");
-                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)
                             ? response
                             : response.cities;
@@ -225,17 +225,17 @@ var ServiceBooking = /** @class */ (function (_super) {
     /**
      * This method returns the tours sold by this seller in the given city.
      * If the sellerId is not set or it is 0, it will return the tours in the given city for all sellers.
-     * @param {string} [cityName=undefined] The name of the selected city (as returned by {@link getTourCities})
-     * @param {Booking.Currencies} currency The currency in which the prices should be returned
-     * @returns {Tour[]} The returned tours
+     * @param cityName The name of the selected city (as returned by {@link getTourCities})
+     * @param The currency in which the prices should be returned
+     * @returns The returned tours
      */
-    ServiceBooking.prototype.getServices = function (currency, cityName) {
+    ServiceBooking.prototype.getServices = function (currency, cityName, options) {
         return __awaiter(this, void 0, void 0, function () {
             var searchParams, url;
             return __generator(this, function (_a) {
                 searchParams = new URLSearchParams(__assign(__assign({}, (cityName && { cityName: cityName })), { currency: currency }));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/services?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)
                             ? response
                             : response.services;
@@ -247,17 +247,17 @@ var ServiceBooking = /** @class */ (function (_super) {
      * This method returns the tours available for the given date. This method can be used if the seller wants the user to book a specific date
      * and/or a specific hour for the tour.
      * You should call this method only if {@link Service.isDateOptional} or {@link Service.isDateRequired} is true for the selected tour.
-     * @param {number} serviceId The id of the selected tour (can be retrieved in the object {@link Service} returned by {@link getTours})
-     * @param {string} date The date on which to get the tours, in ISO string format
+     * @param serviceId The id of the selected tour (can be retrieved in the object {@link Service} returned by {@link getTours})
+     * @param date The date on which to get the tours, in ISO string format
      * @returns {ServiceTripsResponse} The returned information about the tour (tripId and hour)
      */
-    ServiceBooking.prototype.getServiceTrips = function (serviceId, date) {
+    ServiceBooking.prototype.getServiceTrips = function (serviceId, date, options) {
         return __awaiter(this, void 0, void 0, function () {
             var searchParams, url;
             return __generator(this, function (_a) {
                 searchParams = new URLSearchParams({ serviceId: serviceId.toString(), date: date });
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/services/trips?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)
                             ? response
                             : response;
@@ -265,13 +265,13 @@ var ServiceBooking = /** @class */ (function (_super) {
             });
         });
     };
-    ServiceBooking.prototype.createServiceCart = function (serviceCart) {
+    ServiceBooking.prototype.createServiceCart = function (serviceCart, options) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             var _this = this;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/services/carts");
-                return [2 /*return*/, this.callPostApi(url, serviceCart).then(function (response) {
+                return [2 /*return*/, this.callPostApi(url, serviceCart, options).then(function (response) {
                         // Check for errors
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                             // If there was an error, reset cartGuid and remove it from the mts-storage
@@ -335,7 +335,7 @@ var ServiceBooking = /** @class */ (function (_super) {
      * It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
      * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    ServiceBooking.prototype.updateBuyerPassengersDetails = function (buyerDetails) {
+    ServiceBooking.prototype.updateBuyerPassengersDetails = function (buyerDetails, options) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, request, url;
             var _this = this;
@@ -354,7 +354,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                     passengers: []
                 };
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/details");
-                return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
+                return [2 /*return*/, this.callPostApi(url, request, options).then(function (response) {
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                             return response;
                         }
@@ -369,10 +369,10 @@ var ServiceBooking = /** @class */ (function (_super) {
     //#region Reductions APIs
     /**
      * @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
-     * @param {AddReductionRequest} request The information about the reduction to add
+     * @param request The information about the reduction to add
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    ServiceBooking.prototype.addReduction = function (request) {
+    ServiceBooking.prototype.addReduction = function (request, options) {
         return __awaiter(this, void 0, void 0, function () {
             var discountsStep, _i, _a, step, url;
             var _this = this;
@@ -410,7 +410,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                         _c.label = 5;
                     case 5:
                         url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/payment/reduction");
-                        return [2 /*return*/, this.callPostApi(url, __assign(__assign({}, request), { cartGuid: this.cartGuid })).then(function (response) {
+                        return [2 /*return*/, this.callPostApi(url, __assign(__assign({}, request), { cartGuid: this.cartGuid }), options).then(function (response) {
                                 var _a, _b;
                                 if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                                     return response;
@@ -432,7 +432,7 @@ var ServiceBooking = /** @class */ (function (_super) {
      * will be removed from the whole cart.
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    ServiceBooking.prototype.removeReduction = function (tripId) {
+    ServiceBooking.prototype.removeReduction = function (tripId, options) {
         return __awaiter(this, void 0, void 0, function () {
             var discountsStep, queryParams, url;
             var _this = this;
@@ -450,7 +450,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                     cartGuid: this.cartGuid
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/payment/reduction?").concat(queryParams);
-                return [2 /*return*/, this.callDeleteApi(url).then(function (response) {
+                return [2 /*return*/, this.callDeleteApi(url, options).then(function (response) {
                         var _a, _b, _c;
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                             return response;
@@ -475,7 +475,7 @@ var ServiceBooking = /** @class */ (function (_super) {
      * remaining amount with another payment method.
      * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    ServiceBooking.prototype.useWallet = function () {
+    ServiceBooking.prototype.useWallet = function (options) {
         return __awaiter(this, void 0, void 0, function () {
             var issueStep, _i, _a, step, url;
             var _this = this;
@@ -517,7 +517,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                         _c.label = 5;
                     case 5:
                         url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/payment/wallet");
-                        return [2 /*return*/, this.callPostApi(url, { cartGuid: this.cartGuid }).then(function (response) {
+                        return [2 /*return*/, this.callPostApi(url, { cartGuid: this.cartGuid }, options).then(function (response) {
                                 var _a, _b;
                                 if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                                     return response;
@@ -538,7 +538,7 @@ var ServiceBooking = /** @class */ (function (_super) {
      *
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    ServiceBooking.prototype.removeWalletReduction = function () {
+    ServiceBooking.prototype.removeWalletReduction = function (options) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParams, url;
             var _this = this;
@@ -551,7 +551,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                     cartGuid: this.cartGuid
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/payment/wallet?").concat(queryParams);
-                return [2 /*return*/, this.callDeleteApi(url).then(function (response) {
+                return [2 /*return*/, this.callDeleteApi(url, options).then(function (response) {
                         var _a, _b, _c;
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                             return response;
@@ -570,10 +570,10 @@ var ServiceBooking = /** @class */ (function (_super) {
      * @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
+     * @param voucherCode The code of the voucher to use
      * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    ServiceBooking.prototype.useVoucher = function (voucherCode) {
+    ServiceBooking.prototype.useVoucher = function (voucherCode, options) {
         return __awaiter(this, void 0, void 0, function () {
             var discountsStep, _i, _a, step, url;
             var _this = this;
@@ -611,7 +611,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                         _c.label = 5;
                     case 5:
                         url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/payment/voucher");
-                        return [2 /*return*/, this.callPostApi(url, { voucherCode: voucherCode, cartGuid: this.cartGuid }).then(function (response) {
+                        return [2 /*return*/, this.callPostApi(url, { voucherCode: voucherCode, cartGuid: this.cartGuid }, options).then(function (response) {
                                 var _a, _b;
                                 if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
                                     return response;

package/lib/booking/subscriptionBooking.d.ts

@@ -4,6 +4,7 @@ import { AddReductionRequest } from "../types/common/Reduction";
 import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
 import { CreateSubscriptionCartRequest, SubscriptionCart } from "../types/subscriptions/SubscriptionCart";
 import { Subscription } from "../types/subscriptions/Subscriptions";
+import { ApiCallOptions } from "../utils/apiCall";
 import { Booking } from "./booking";
 export declare class SubscriptionBooking extends Booking {
     private cart?;
@@ -59,102 +60,102 @@ export declare class SubscriptionBooking extends Booking {
     }>;
     getCart(): SubscriptionCart | undefined;
     resetBooking(): void;
-    fetchAndSetCart(cartGuid: string): Promise<void>;
-    fetchCart(cartGuid: string): Promise<SubscriptionCart>;
+    fetchAndSetCart(cartGuid: string, options?: ApiCallOptions): Promise<void>;
+    fetchCart(cartGuid: string, options?: ApiCallOptions): Promise<SubscriptionCart>;
     /**
      * This method allows to delete a cart, thus allowing the user to exit from the booking process.
      * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
      * data will be deleted.
      */
-    deleteCart(): Promise<ErrorResponse | any>;
+    deleteCart(options?: ApiCallOptions): Promise<ErrorResponse | any>;
     /**
      * This method returns the possible departures for all subscriptions sold by this seller.
-     * @returns {string[]} The list of possible departures
+     * @returns The list of possible departures
      */
-    getSubscriptionsDepartures(): Promise<ErrorResponse | string[]>;
+    getSubscriptionsDepartures(options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
     /**
      * This method returns the possible destination for the subscriptions sold by this seller that start at the selected departure.
-     * @param {string} departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
-     * @returns {string[]} The list of possible destinations
+     * @param departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
+     * @returns The list of possible destinations
      */
-    getSubscriptionsDestinations(departureStopName: string): Promise<ErrorResponse | string[]>;
+    getSubscriptionsDestinations(departureStopName: string, options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
     /**
      * This method returns the possible validity types for the subscriptions sold by this seller between the selected departure and destination.
      * The validity type is the duration of the subscription (1 week, 1 month, etc.). See {@link ValidityTypes} for more details.
-     * @param {string} departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
-     * @param {string} destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
-     * @returns {ValidityTypes[]} The list of possible validity types
+     * @param departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
+     * @param destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
+     * @returns The list of possible validity types
      */
-    getSubscriptionsValidityTypes(departureStopName: string, destinationStopName: string): Promise<ErrorResponse | SubscriptionBooking.ValidityTypes[]>;
+    getSubscriptionsValidityTypes(departureStopName: string, destinationStopName: string, options?: ApiCallOptions): Promise<ErrorResponse | SubscriptionBooking.ValidityTypes[]>;
     /**
      * This method returns the subscriptions that match the given parameters.
      * Note that it will always return the subscription for the one-way trip.
      * If you want to get the subscription for the round trip, you have to call this method twice (make sure to swap departureStopName and destinationStopName)
-     * @param {string} departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
-     * @param {string} destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
-     * @param {string} validityType The validity type (as returned by {@link getSubscriptionsValidityTypes})
-     * @returns {Array<Subscription>} The subscriptions that match the given parameters
+     * @param departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
+     * @param destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
+     * @param validityType The validity type (as returned by {@link getSubscriptionsValidityTypes})
+     * @returns The subscriptions that match the given parameters
      */
-    getSubscriptions(departureStopName: string, destinationStopName: string, validityType: string): Promise<ErrorResponse | Subscription[]>;
+    getSubscriptions(departureStopName: string, destinationStopName: string, validityType: string, options?: ApiCallOptions): Promise<ErrorResponse | Subscription[]>;
     /**
      * This method returns the availability of the subscription for the given parameters.
      * Note that, contrary for the previous method, you should make one single request for both the outbound and return trip.
-     * @param {GetSubscriptionAvailabilityRequest} request the request object containing the parameters for the availability check
-     * @returns {GetSubscriptionAvailabilityResponse} The availability of the subscription for the given parameters
+     * @param request the request object containing the parameters for the availability check
+     * @returns The availability of the subscription for the given parameters
      */
-    getSubscriptionAvailabilities(request: GetSubscriptionAvailabilityRequest): Promise<ErrorResponse | GetSubscriptionAvailabilityResponse>;
+    getSubscriptionAvailabilities(request: GetSubscriptionAvailabilityRequest, options?: ApiCallOptions): Promise<ErrorResponse | GetSubscriptionAvailabilityResponse>;
     /**
      * This method creates a subscription cart for the given parameters.
-     * @param {CreateSubscriptionCartRequest} request the request object containing the parameters for the availability check
-     * @returns {SubscriptionCart} The created cart
+     * @param request the request object containing the parameters for the availability check
+     * @returns The created cart
      */
-    createSubscriptionCart(request: CreateSubscriptionCartRequest): Promise<ErrorResponse | SubscriptionCart>;
+    createSubscriptionCart(request: CreateSubscriptionCartRequest, options?: ApiCallOptions): Promise<ErrorResponse | SubscriptionCart>;
     /**
      * @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>;
+    getBuyerPassengersDetails(options?: ApiCallOptions): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
     /**
      * @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.
+     * @param passengersDetails The object containing the buyer and the passengers information.
      * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    updateBuyerPassengersDetails(passengersDetails: EditPassengersDetailsRequest): Promise<ErrorResponse | boolean>;
+    updateBuyerPassengersDetails(passengersDetails: EditPassengersDetailsRequest, options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
     /**
      * @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
-     * @param {AddReductionRequest} request The information about the reduction to add
+     * @param request The information about the reduction to add
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    addReduction(request: AddReductionRequest): Promise<ErrorResponse | boolean>;
+    addReduction(request: AddReductionRequest, options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
     /**
      * @description This method allows to remove a reduction from the whole cart or from a single trip in the cart.
      * @param tripId The id of the trip from which the reduction should be removed. If the tripId is 0, then the reduction
      * will be removed from the whole cart.
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    removeReduction(tripId: number): Promise<ErrorResponse | boolean>;
+    removeReduction(tripId: number, options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
     /**
      * @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, true otherwise.
      */
-    useWallet(): Promise<ErrorResponse | boolean>;
+    useWallet(options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
     /**
      * @description This method allows to remove a waller reduction from the cart.
      *
      * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
      */
-    removeWalletReduction(): Promise<ErrorResponse | boolean>;
+    removeWalletReduction(options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
     /**
      * @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
+     * @param voucherCode The code of the voucher to use
      * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    useVoucher(voucherCode: string): Promise<ErrorResponse | boolean>;
+    useVoucher(voucherCode: string, options?: ApiCallOptions): Promise<ErrorResponse | boolean>;
 }
 export declare namespace SubscriptionBooking {
     const createBooking: ({ env, subKey, debug, language, sessionId, restoreState, accessToken, sellerId, resellerId, dbType }: Omit<Booking.BookingConfig, "bookingType">) => Promise<SubscriptionBooking>;