mts-booking-library 1.2.0 → 1.2.1

package/lib/booking/journeyBooking.d.ts

@@ -1,6 +1,6 @@
 import { MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
-import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
+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";
@@ -49,6 +49,15 @@ export declare class JourneyBooking extends Booking {
      * 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.

package/lib/booking/journeyBooking.js

@@ -268,6 +268,44 @@ var JourneyBooking = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * @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.
+     */
+    JourneyBooking.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.

package/lib/booking/subscriptionBooking.d.ts

@@ -1,7 +1,7 @@
 import { MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
 import { Cart } from "../types/common/Cart";
-import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
+import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
 import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
 import { CreateSubscriptionCartRequest, SubscriptionCart } from "../types/subscriptions/SubscriptionCart";
 import { Subscription } from "../types/subscriptions/Subscriptions";
@@ -72,6 +72,15 @@ export declare class SubscriptionBooking extends Booking {
      * 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.

package/lib/booking/subscriptionBooking.js

@@ -317,6 +317,44 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * @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.

package/lib/index.d.ts

@@ -2,7 +2,8 @@ export { Booking } from "./booking/booking";
 export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
-export { Person, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse, DEFAULT_PERSON } from "./types/common/Person";
+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";

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.SeatStatus = exports.BusCellTypes = exports.PaymentMethods = exports.GatewayTypes = 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,6 +15,7 @@ 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; } });

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

@@ -18,6 +18,7 @@ export type Person = {
     notes?: string;
 };
 export declare const DEFAULT_PERSON: Person;
+export declare const initializePerson: (person?: Person | undefined | null) => Person;
 /**
  * @description Represents the response of the {@link getBuyerPassengersDetails} method.
  *
@@ -31,18 +32,22 @@ export type GetBuyerPassengersDetailsResponse = {
     passengers: Person[];
     tariffs: Map<number, PassengerTariff>;
 };
+/**
+ * @description Represents the type of the passengers array in {@link EditPassengersDetailsRequest}.
+ */
+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 {Person[]} passengers - An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers.
+ * @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: Person[] & {
-        tripsToTariffs: {
-            [tripId: number]: number;
-        };
-    };
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Library for use MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",