mts-booking-library 1.3.15 → 1.3.16

package/lib/booking/journeyBooking.d.ts

@@ -1,5 +1,5 @@
 import { ErrorResponse } from "../types/ErrorResponse";
-import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { Buyer, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
 import { BusMatrix } from "../types/journeys/BusMatrix";
 import { CreateJourneyCartRequest, JourneyCart } from "../types/journeys/JourneyCart";
@@ -96,13 +96,12 @@ export declare class JourneyBooking extends Booking {
     getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
     /**
      * @description This method shall be called when the user wants to retrieve information about an esisting buyer.
-     * @param {string} [linkavelCard=undefined] The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
-     * A linkavelCard number is a string of 9 digits.
-     * @param {string} [phoneNumber=undefined] The phone number of the buyer. This parameter is required if linkavelCard is not set.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
     /**
      * @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

@@ -349,9 +349,8 @@ var JourneyBooking = /** @class */ (function (_super) {
     };
     /**
      * @description This method shall be called when the user wants to retrieve information about an esisting buyer.
-     * @param {string} [linkavelCard=undefined] The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
-     * A linkavelCard number is a string of 9 digits.
-     * @param {string} [phoneNumber=undefined] The phone number of the buyer. This parameter is required if linkavelCard is not set.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */

package/lib/booking/serviceBooking.d.ts

@@ -1,5 +1,5 @@
 import { ErrorResponse } from "../types/ErrorResponse";
-import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { Buyer, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
 import { Service, ServiceTripsResponse } from "../types/services/Service";
 import { CreateServiceCartRequest, ServiceCart } from "../types/services/ServiceCart";
@@ -98,20 +98,19 @@ export declare class ServiceBooking extends Booking {
     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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
     /**
      * @description This method shall be called when the user wants to update the buyer information.
-     * @param {Person | null} buyerDetails The object containing the buyer information.
+     * @param buyerDetails The object containing the buyer information.
      * 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.
      */
-    updateBuyerPassengersDetails(buyerDetails: Person | null): Promise<ErrorResponse | boolean>;
+    updateBuyerPassengersDetails(buyerDetails: Buyer | null): 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

package/lib/booking/serviceBooking.js

@@ -329,13 +329,12 @@ var ServiceBooking = /** @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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    ServiceBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+    ServiceBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, searchParams, url;
             return __generator(this, function (_a) {
@@ -347,10 +346,10 @@ var ServiceBooking = /** @class */ (function (_super) {
                 if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
                     throw Error("The status of the cart does not allow to call this API");
                 }
-                if (!linkavelCardNumber && !linkavelCardPhoneNumber) {
+                if (!linkavelCard && !phoneNumber) {
                     throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
                 }
-                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCardNumber && { linkavelCardNumber: linkavelCardNumber })), (linkavelCardPhoneNumber && { linkavelCardPhoneNumber: linkavelCardPhoneNumber })));
+                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url).then(function (response) {
                         // Check for errors
@@ -364,7 +363,7 @@ var ServiceBooking = /** @class */ (function (_super) {
     };
     /**
      * @description This method shall be called when the user wants to update the buyer information.
-     * @param {Person | null} buyerDetails The object containing the buyer information.
+     * @param buyerDetails The object containing the buyer information.
      * 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.
      */

package/lib/booking/subscriptionBooking.d.ts

@@ -1,5 +1,5 @@
 import { ErrorResponse } from "../types/ErrorResponse";
-import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { Buyer, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
 import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
 import { CreateSubscriptionCartRequest, SubscriptionCart } from "../types/subscriptions/SubscriptionCart";
@@ -117,13 +117,12 @@ export declare class SubscriptionBooking extends Booking {
     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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
     /**
      * @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

@@ -408,13 +408,12 @@ 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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+    SubscriptionBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, searchParams, url;
             return __generator(this, function (_a) {
@@ -426,10 +425,10 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                 if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
                     throw Error("The status of the cart does not allow to call this API");
                 }
-                if (!linkavelCardNumber && !linkavelCardPhoneNumber) {
+                if (!linkavelCard && !phoneNumber) {
                     throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
                 }
-                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCardNumber && { linkavelCardNumber: linkavelCardNumber })), (linkavelCardPhoneNumber && { linkavelCardPhoneNumber: linkavelCardPhoneNumber })));
+                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url).then(function (response) {
                         // Check for errors

package/lib/booking/tplBooking.d.ts

@@ -1,6 +1,6 @@
 import { ErrorResponse } from "../types/ErrorResponse";
 import { City } from "../types/common/City";
-import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { Buyer, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
 import { TariffType, TermsType } from "../types/common/Tariffs";
 import { GetTariffsResponse } from "../types/tpl/GetTariffsResponse";
@@ -118,20 +118,19 @@ export declare class TplBooking extends Booking {
     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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
     /**
      * @description This method shall be called when the user wants to update the buyer information.
-     * @param {Person | null} buyerDetails The object containing the buyer information.
+     * @param buyerDetails The object containing the buyer information.
      * 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.
      */
-    updateBuyerPassengersDetails(buyerDetails: Person | null): Promise<ErrorResponse | boolean>;
+    updateBuyerPassengersDetails(buyerDetails: Buyer | null): 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

package/lib/booking/tplBooking.js

@@ -381,7 +381,7 @@ var TplBooking = /** @class */ (function (_super) {
                         return {
                             buyerDataStatus: response.buyerDataStatus,
                             buyer: response.buyer,
-                            passengers: []
+                            passengers: null
                         };
                     })];
             });
@@ -389,13 +389,12 @@ var TplBooking = /** @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.
+     * @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard 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.
      */
-    TplBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+    TplBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, searchParams, url;
             return __generator(this, function (_a) {
@@ -407,10 +406,10 @@ var TplBooking = /** @class */ (function (_super) {
                 if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
                     throw Error("The status of the cart does not allow to call this API");
                 }
-                if (!linkavelCardNumber && !linkavelCardPhoneNumber) {
+                if (!linkavelCard && !phoneNumber) {
                     throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
                 }
-                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCardNumber && { linkavelCardNumber: linkavelCardNumber })), (linkavelCardPhoneNumber && { linkavelCardPhoneNumber: linkavelCardPhoneNumber })));
+                searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url).then(function (response) {
                         // Check for errors
@@ -424,7 +423,7 @@ var TplBooking = /** @class */ (function (_super) {
     };
     /**
      * @description This method shall be called when the user wants to update the buyer information.
-     * @param {Person | null} buyerDetails The object containing the buyer information.
+     * @param buyerDetails The object containing the buyer information.
      * 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.
      */

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

@@ -1,22 +1,25 @@
 import { PassengerTariff } from "./Tariffs";
 /**
  * @description Represents a person, that can be a passenger or the buyer.
- *
- * @property {number} id - The unique identifier for the person.
- * @property {string} name - The name of the person.
- * @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 = {
+    /** The unique identifier for the person. */
     id: number;
+    /** The name of the person. */
     name: string;
+    /** The last name of the person. */
     lastName: string;
+    /** The email of the person. */
     email: string;
+    /** The phone number of the person. */
     phoneNumber: string;
+    /** The notes for this person. */
     notes?: string;
 };
+export type Buyer = Person & {
+    /** The social security number of the buyer, if provided. */
+    socialSecurityNumber: string | null;
+};
 export declare const DEFAULT_PERSON: Person;
 export declare const initializePerson: (person?: Person | undefined | null) => Person;
 /**
@@ -51,9 +54,9 @@ export type GetBuyerPassengersDetailsResponse = {
     /** Whether the form for the buyer data is required, optional or cannot be specified. */
     buyerDataStatus: BuyerDataStatus;
     /** The {@link Person} object representing the buyer. */
-    buyer: Person;
+    buyer: Buyer | null;
     /** An array of {@link GetPassenger} objects representing the passengers. */
-    passengers: GetPassenger[];
+    passengers: GetPassenger[] | null;
 };
 /**
  * @description Represents the type of the passengers array in {@link EditPassengersDetailsRequest}.
@@ -67,13 +70,14 @@ export type EditPassengerRequestType = Person & {
 };
 /**
  * @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 | null} buyer - The {@link Person} object representing the buyer.
- * It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
+ * This type shall be used as request for the {@link Booking.updateBuyerPassengersDetails} method.
  */
 export type EditPassengersDetailsRequest = {
+    /** An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers. */
     passengers: EditPassengerRequestType[];
-    buyer: Person | null;
+    /**
+     * The {@link Person} object representing the buyer.
+     * It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
+     */
+    buyer: Buyer | null;
 };

package/lib/types/common/Person.js

@@ -1,5 +1,4 @@
 "use strict";
-// This module contains the types to manage the passengers information
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = void 0;
 exports.DEFAULT_PERSON = {

package/lib/types/tpl/TplCart.d.ts

@@ -26,16 +26,16 @@ export type TplBookingType = {
 };
 /**
  * @description Represents a `TplBookingInfo`, which contains general information about a tpl booking.
- * @property {boolean} isSubscription - Whether the booking is a subscription or a single ticket.
- * @property {number} superAreaId - The id of the super area.
- * @property {number} validity - The validity of the ticket (or of the subscription).
- * @property {string} startDate - The start date of the ticket (or of the subscription).
- * @property {string} endDate - The end date of the ticket (or of the subscription).
  */
 export type TplBookingInfo = {
+    /** Whether the booking is a subscription or a single ticket. */
     isSubscription: boolean;
+    /** The id of the super area. */
     superAreaId: number;
-    validity: number;
+    /** The validity of the ticket (or of the subscription). */
+    validity: string;
+    /** The start date of the ticket (or of the subscription). */
     startDate: string;
+    /** The end date of the ticket (or of the subscription). */
     endDate: string;
 };

package/package.json

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