mts-booking-library 1.3.14 → 1.3.15

package/lib/booking/tplBooking.d.ts

@@ -103,11 +103,13 @@ export declare class TplBooking extends Booking {
     getTariffs(superAreaId: number, termsTypeId: number | null, onlyTickets: boolean, onlySubscriptions: boolean): Promise<ErrorResponse | GetTariffsResponse>;
     /**
      * This method allows to create a TPL cart.
-     * @param {Map<number, number>} tariffIdToQuantity A map that associates a tariff id (the one chosen by the user) to the number of tickets to buy for that tariff.
-     * @param {Booking.Currencies} currency The currency in which the ticket is priced.
-     * @param {string} [startDate] The start date of the ticket. This is optional and should be used only for subscriptions.
+     * @param tariffIdToQuantity A map that associates a tariff id (the one chosen by the user) to the number of tickets to buy for that tariff.
+     * @param currency The currency in which the ticket is priced.
+     * @param startDate The start date of the ticket. This is optional and should be used only for subscriptions.
+     * @param isCurrentPeriod Whether the subscription is for the current period. This is optional and should be used only for subscriptions.
+     * @param renewSubscriptionTicketPNR The PNR of the subscription ticket to renew. This is optional and should be used only for subscriptions.
      */
-    createTplCart(tariffIdToQuantity: Map<number, number>, currency: Booking.Currencies, startDate?: string): Promise<ErrorResponse | TplCart>;
+    createTplCart(tariffIdToQuantity: Map<number, number>, currency: Booking.Currencies, startDate?: string, isCurrentPeriod?: boolean, renewSubscriptionTicketPNR?: string): Promise<ErrorResponse | TplCart>;
     /**
      * @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,

package/lib/booking/tplBooking.js

@@ -313,11 +313,13 @@ var TplBooking = /** @class */ (function (_super) {
     };
     /**
      * This method allows to create a TPL cart.
-     * @param {Map<number, number>} tariffIdToQuantity A map that associates a tariff id (the one chosen by the user) to the number of tickets to buy for that tariff.
-     * @param {Booking.Currencies} currency The currency in which the ticket is priced.
-     * @param {string} [startDate] The start date of the ticket. This is optional and should be used only for subscriptions.
+     * @param tariffIdToQuantity A map that associates a tariff id (the one chosen by the user) to the number of tickets to buy for that tariff.
+     * @param currency The currency in which the ticket is priced.
+     * @param startDate The start date of the ticket. This is optional and should be used only for subscriptions.
+     * @param isCurrentPeriod Whether the subscription is for the current period. This is optional and should be used only for subscriptions.
+     * @param renewSubscriptionTicketPNR The PNR of the subscription ticket to renew. This is optional and should be used only for subscriptions.
      */
-    TplBooking.prototype.createTplCart = function (tariffIdToQuantity, currency, startDate) {
+    TplBooking.prototype.createTplCart = function (tariffIdToQuantity, currency, startDate, isCurrentPeriod, renewSubscriptionTicketPNR) {
         return __awaiter(this, void 0, void 0, function () {
             var url, processedTariffIdToQuantity, request;
             var _this = this;
@@ -327,7 +329,7 @@ var TplBooking = /** @class */ (function (_super) {
                 tariffIdToQuantity.forEach(function (value, key) {
                     processedTariffIdToQuantity[key] = value;
                 });
-                request = __assign({ tariffIdToQuantity: processedTariffIdToQuantity, currency: currency }, (startDate && { startDate: startDate }));
+                request = __assign(__assign(__assign({ tariffIdToQuantity: processedTariffIdToQuantity, currency: currency }, (startDate !== undefined && { startDate: startDate })), (isCurrentPeriod !== undefined && { isCurrentPeriod: isCurrentPeriod })), (renewSubscriptionTicketPNR !== undefined && { renewSubscriptionTicketPNR: renewSubscriptionTicketPNR }));
                 // Call the API
                 return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
                         // Check for errors

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

@@ -37,23 +37,22 @@ export type GetPassenger = Person & {
     returnTariffs: Map<number, PassengerTariff[]> | null;
 };
 export declare enum BuyerDataStatus {
+    /** The buyer data are optional. Buyer form shall be displayed, but the user can skip it. */
     OPTIONAL = 0,
+    /** The buyer data are required. Buyer form shall be displayed and the user cannot skip it. */
     REQUIRED = 1,
+    /** The buyer data cannot be specified. Buyer form shall not be displayed. */
     CANNOT_BE_SPECIFIED = 2
 }
 /**
- * @description Represents the response of the {@link getBuyerPassengersDetails} method.
- *
- * @property {BuyerDataStatus} buyerDataStatus - Whether the for for the buyer data are required, optional or cannot be specified.
- * - `OPTIONAL`: The buyer data are optional. Buyer form shall be displayed, but the user can skip it.
- * - `REQUIRED`: The buyer data are required. Buyer form shall be displayed and the user cannot skip it.
- * - `CANNOT_BE_SPECIFIED`: The buyer data cannot be specified. Buyer form shall not be displayed.
- * @property {Person} buyer - The {@link Person} object representing the buyer.
- * @property {GetPassenger[]} passengers - An array of {@link GetPassenger} objects representing the passengers.
+ * Represents the response of the {@link getBuyerPassengersDetails} method.
  */
 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;
+    /** An array of {@link GetPassenger} objects representing the passengers. */
     passengers: GetPassenger[];
 };
 /**

package/lib/types/common/Person.js

@@ -18,7 +18,10 @@ var initializePerson = function (person) {
 exports.initializePerson = initializePerson;
 var BuyerDataStatus;
 (function (BuyerDataStatus) {
+    /** The buyer data are optional. Buyer form shall be displayed, but the user can skip it. */
     BuyerDataStatus[BuyerDataStatus["OPTIONAL"] = 0] = "OPTIONAL";
+    /** The buyer data are required. Buyer form shall be displayed and the user cannot skip it. */
     BuyerDataStatus[BuyerDataStatus["REQUIRED"] = 1] = "REQUIRED";
+    /** The buyer data cannot be specified. Buyer form shall not be displayed. */
     BuyerDataStatus[BuyerDataStatus["CANNOT_BE_SPECIFIED"] = 2] = "CANNOT_BE_SPECIFIED";
 })(BuyerDataStatus || (exports.BuyerDataStatus = BuyerDataStatus = {}));

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

@@ -1,17 +1,43 @@
 /**
  * This represents a tariff, which defined the price to pay for a certain ticket.
- * @param {number} id - The id of the tariff.
- * @param {number} tariffTypeId - The id of the tariff type.
- * @param {number} termsTypeId - The id of the terms type.
- * @param {number} value - The value of the tariff (in the currency specified in the {@link Booking} object).
- * @param {number} quantity - The number of passengers to which this tariff applies.
  */
 export type Tariff = {
+    /** The id of the tariff */
     id: number;
+    /** The id of the tariff type */
     tariffTypeId: number;
+    /** The id of the terms type */
     termsTypeId: number;
+    /** The id of the tariff plan */
+    tariffPlanId: number;
+    /** The id of the seller */
+    sellerId: number;
+    /** The id of the associated segment, if any */
+    segmentId: number | null;
+    /** The id of the associated super area, if any */
+    superAreaId: number | null;
+    /** The id of the associated extra, if any */
+    extraId: number | null;
+    /** The value of the tariff (in the currency specified in the {@link Booking} object) */
     value: number;
+    /** @deprecated Use {@link Tariff.valueCurrencies} instead */
+    currency: null;
+    /** The value of the tariff in the different currencies */
+    valueCurrencies: {
+        percentage: number | null;
+        eur: number | null;
+        usd: number | null;
+        chf: number | null;
+        id: number;
+    };
+    /** The number of passengers to which this tariff applies */
     quantity: number;
+    /** The custom code for one-way tickets */
+    oneWayCode: string | null;
+    /** The custom code for round trip tickets */
+    roundTripCode: string | null;
+    /** Whether the tariff is active */
+    isActive: boolean;
 };
 /**
  * This represents a tariff matrix, returned when searching Journeys or Services.
@@ -22,41 +48,57 @@ export type Tariff = {
 export type TariffsMatrix = (Tariff | undefined)[][];
 /**
  * This represents a tariff type (e.g. "Adult", "Child", "Over65", ...).
- * @param {number} id - The id of the tariff type in the db.
- * @param {string} name - The name of the tariff type.
- * @param {string} description - The description of the tariff type.
- * @param {boolean} requiredPassengersName - Whether the passengers' names are required for this tariff type.
- * @param {number} numberOfOccupiedSeats - The number of seats occupied by this tariff type.
- * @param {string} bookingProcessDescription - A message to be shown to the user during the booking process that describes the tariff type,
- * including info on the rules that apply to it.
  */
 export type TariffType = {
+    /** The id of the tariff type in the db */
     id: number;
+    /** The name of the tariff type */
     name: string;
+    /** The description of the tariff type */
     description: string;
+    /** Whether the passengers' names are required for this tariff type */
     requiredPassengersName: boolean;
+    /** The number of seats occupied by this tariff type */
     numberOfOccupiedSeats: number;
+    /**
+     * A message to be shown to the user during the booking process that describes the tariff type,
+     * including info on the rules that apply to it
+     */
     bookingProcessDescription: string;
 };
 /**
  * This represents a terms type (e.g. "Standard", "Business", ...).
- * @param {number} id - The id of the terms type in the db.
- * @param {string} name - The name of the terms type.
- * @param {string} description - The description of the terms type.
- * @param {boolean} isRefundAllowed - Whether tickets refunds are allowed for this terms type.
- * @param {boolean} isChangeAllowed - Whether changing the ticket is allowed for this terms type.
- * @param {string} validationRulesString - A string containing the validation rules that apply to this terms type.
- * @param {string} bookingProcessDescription - A message to be shown to the user during the booking process that describes the terms type,
- * including info on the rules that apply to it.
  */
 export type TermsType = {
+    /** The id of the terms type in the db */
     id: number;
+    /** The name of the terms type */
     name: string;
+    /** The description of the terms type */
     description: string;
+    /** Whether tickets refunds are allowed for this terms type */
     isRefundAllowed: boolean;
+    /** Whether changing the ticket is allowed for this terms type */
     isChangeAllowed: boolean;
+    /** A string containing the validation rules that apply to this terms type */
     validationRulesString: string;
+    /**
+     * A message to be shown to the user during the booking process that describes the terms type,
+     * including info on the rules that apply to it
+     */
     bookingProcessDescription: string;
+    /** Whether these terms are the default ones */
+    isDefault: boolean;
+    /** Whether the terms are for a subscription */
+    isSubscription: boolean;
+    /** Whether a start date can be selected for this ticket */
+    canSelectStartDate: boolean;
+    /** Whether a start date is mandatory for this ticket */
+    isStartDateMandatory: boolean;
+    /** The validation rule for these terms */
+    validationRule: any | null;
+    /** The rules associated with these terms */
+    rules: any | null;
 };
 export type TariffSummary = {
     quantity: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.3.14",
+  "version": "1.3.15",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -20,7 +20,7 @@
     "jest": "^29.7.0",
     "prettier": "^3.3.3",
     "ts-jest": "^29.2.3",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.4"
   },
   "files": [
     "lib/**/*"