mts-booking-library 1.1.8 → 1.1.9

package/lib/booking/subscriptionBooking.d.ts

@@ -58,6 +58,11 @@ export declare class SubscriptionBooking extends Booking {
      * @returns {GetSubscriptionAvailabilityResponse} The availability of the subscription for the given parameters
      */
     getSubscriptionAvailabilities(request: GetSubscriptionAvailabilityRequest): Promise<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
+     */
     createSubscriptionCart(request: CreateSubscriptionCartRequest): Promise<SubscriptionCart>;
 }
 export declare namespace SubscriptionBooking {

package/lib/booking/subscriptionBooking.js

@@ -219,6 +219,11 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * This method creates a subscription cart for the given parameters.
+     * @param {CreateSubscriptionCartRequest} request the request object containing the parameters for the availability check
+     * @returns
+     */
     SubscriptionBooking.prototype.createSubscriptionCart = function (request) {
         return __awaiter(this, void 0, void 0, function () {
             var url;

package/lib/index.d.ts

@@ -3,7 +3,7 @@ export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
 export { Person, PassengersDetails, DEFAULT_PERSON } from "./types/common/Person";
-export { TariffMatrix, TariffSummary, TariffType, TermsType } from "./types/common/Tariffs";
+export { Tariff, TariffsMatrix, TariffSummary, TariffType, TermsType } from "./types/common/Tariffs";
 export { JourneyCart, JourneyBookingType, CreateJourneyCartRequest, TripBookingInfo, DEFAULT_CREATE_JOURNEY_CART } from "./types/journeys/JourneyCart";
 export { JourneyInfo } from "./types/journeys/JourneyInfo";
 export { JourneySearchRequest, JourneySearchResult, DEFAULT_JOURNEY_SEARCH } from "./types/journeys/JourneySearch";

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

@@ -1,9 +1,30 @@
-export type TariffMatrix = {
+/**
+ * This represents a tariff, a part of a {@link TariffsMatrix} (returned when searching Journeys or Services).
+ * @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 = {
     tariffTypeId: number;
     termsTypeId: number;
     value: number;
     quantity: number;
-}[][];
+};
+/**
+ * This represents a tariff matrix, returned when searching Journeys or Services.
+ * It is a 2D array of {@link Tariff} objects. On the rows, there are the terms types, while on the columns there are the tariff types.
+ */
+export type TariffsMatrix = Tariff[][];
+/**
+ * This represents a tariff type, returned when searching Journeys or Services. This shall be used the build the header of the tariff matrix.
+ * @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 = {
     name: string;
     description: string;
@@ -11,6 +32,16 @@ export type TariffType = {
     numberOfOccupiedSeats: number;
     bookingProcessDescription: string;
 };
+/**
+ * This represents a terms type, returned when searching Journeys or Services. This shall be used the build the header of the rows of the tariff matrix.
+ * @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 = {
     name: string;
     description: string;

package/lib/types/journeys/JourneyCart.d.ts

@@ -1,6 +1,6 @@
 import { Booking } from "../../booking/booking";
 import { Cart } from "../common/Cart";
-import { TariffMatrix, TariffSummary } from "../common/Tariffs";
+import { TariffsMatrix, TariffSummary } from "../common/Tariffs";
 import { Stop } from "./Stop";
 /**
  * @description Object containing information about a trip of a selected journey. This object is part of the {@link CreateJourneyCartRequest} object
@@ -9,13 +9,13 @@ import { Stop } from "./Stop";
  * @property {number} tripId - The unique identifier for the trip.
  * @property {number} departureStopId - The unique identifier for the departure stop.
  * @property {number} destinationStopId - The unique identifier for the destination stop.
- * @property {TariffMatrix} tariffsMatrix - The tariff matrix for pricing the outbound journey.
+ * @property {TariffsMatrix} tariffsMatrix - The tariff matrix for pricing the outbound journey.
  */
 export type TripBookingInfo = {
     tripId: number;
     departureStopId: number;
     destinationStopId: number;
-    tariffsMatrix: TariffMatrix;
+    tariffsMatrix: TariffsMatrix;
 };
 /**
  * @description This is the object to be passed to `JourneyBooking.createJourneyCart`, containing information about the selected service.

package/lib/types/journeys/Trip.d.ts

@@ -1,10 +1,10 @@
-import { TariffMatrix, TariffType, TermsType } from "../common/Tariffs";
+import { TariffsMatrix, TariffType, TermsType } from "../common/Tariffs";
 export type Trip = {
     id: number;
     date: Date;
     departureStopName: string;
     destinationStopName: string;
-    tariffsMatrix: TariffMatrix;
+    tariffsMatrix: TariffsMatrix;
     tariffTypes: TariffType[];
     termsTypes: TermsType[];
 };

package/lib/types/services/Service.d.ts

@@ -1,4 +1,4 @@
-import { TariffMatrix, TariffType, TermsType } from "../common/Tariffs";
+import { TariffsMatrix, TariffType, TermsType } from "../common/Tariffs";
 import { Line } from "./Line";
 import { ServiceInfo } from "./ServiceInfo";
 /**
@@ -8,7 +8,7 @@ import { ServiceInfo } from "./ServiceInfo";
  * @property {number} id - The unique identifier for the service.
  * @property {Line} line - Information about the line or route associated with the service.
  * @property {ServiceInfo} info - Information about the service itself.
- * @property {TariffMatrix} tariffsMatrix - The tariff matrix for pricing.
+ * @property {TariffsMatrix} tariffsMatrix - The tariff matrix for pricing.
  * @property {TariffType[]} tariffTypes - An array of tariff types available for the service.
  * @property {TermsType[]} termsTypes - An array of terms types related to the service.
  * @property {boolean} isDateOptional - Indicates whether a date can be optionally specified for this service.
@@ -19,7 +19,7 @@ export type Service = {
     id: number;
     line: Line;
     info: ServiceInfo;
-    tariffsMatrix: TariffMatrix;
+    tariffsMatrix: TariffsMatrix;
     tariffTypes: TariffType[];
     termsTypes: TermsType[];
     isDateOptional: boolean;

package/lib/types/services/ServiceCart.d.ts

@@ -1,6 +1,6 @@
 import { Booking } from "../../booking/booking";
 import { Cart } from "../common/Cart";
-import { TariffMatrix, TariffSummary } from "../common/Tariffs";
+import { TariffsMatrix, TariffSummary } from "../common/Tariffs";
 import { ServiceTrip } from "./Service";
 /**
  * @description This is the object to be passed to `ServiceBooking.createServiceCart`, containing information about the selected service.
@@ -8,7 +8,7 @@ import { ServiceTrip } from "./Service";
  * @property {Booking.Currencies} currency - The currency in which the service is priced.
  * @property {Object} service - Information about the selected service.
  * @property {number} service.serviceId - The unique identifier for the service.
- * @property {TariffMatrix} service.tariffsMatrix - The tariff matrix for pricing the service.
+ * @property {TariffsMatrix} service.tariffsMatrix - The tariff matrix for pricing the service.
  * @property {Date|undefined} [service.date] - The date for the service (optional).
  * @property {number|undefined} [service.tripId] - The unique identifier for the trip (optional).
  */
@@ -16,7 +16,7 @@ export type CreateServiceCartRequest = {
     currency: Booking.Currencies;
     service: {
         serviceId: number;
-        tariffsMatrix: TariffMatrix;
+        tariffsMatrix: TariffsMatrix;
         date?: Date;
         tripId?: number;
     };

package/lib/types/subscriptions/SubscriptionCart.d.ts

@@ -28,7 +28,7 @@ export type CreateSubscriptionCartRequest = {
     outboundRouteId: number;
     returnRouteId: number;
     numberOfPassengers: number;
-    period: SubscriptionPeriod[];
+    periods: SubscriptionPeriod[];
 };
 /**
  * @description This is the object that describes which perios should be booked.

package/package.json

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