mts-booking-library 3.0.9 → 3.0.11

package/lib/booking/tplBooking.d.ts

@@ -5,7 +5,7 @@ import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Perso
 import { AddReductionRequest } from "../types/common/Reduction";
 import { TariffType, TermsType } from "../types/common/Tariffs";
 import { GetTariffsResponse } from "../types/tpl/GetTariffsResponse";
-import { GetSuperAreasRequest, SuperArea } from "../types/tpl/SuperArea";
+import { GetCitiesRequest, GetSuperAreasRequest, SuperArea } from "../types/tpl/SuperArea";
 import { BookingSkip, TplCart } from "../types/tpl/TplCart";
 import { GetTripsResponse } from "../types/tpl/Trips";
 import { ApiCallOptions } from "../utils/apiCall";
@@ -121,10 +121,11 @@ export declare class TplBooking extends Booking {
     deleteCart(options?: ApiCallOptions): Promise<ErrorResponse | any>;
     /**
      * This method allows to get the list of cities where it is possible to book a TPL service.
+     * @param request Optional query options (e.g. {@link GetCitiesRequest.type}).
      * @returns An array of {@link City} objects representing the cities where it is possible to book a TPL service
      * if the call is successful, an {@link ErrorResponse} object otherwise.
      */
-    getCities(options?: ApiCallOptions): Promise<ErrorResponse | City[]>;
+    getCities(request?: GetCitiesRequest, options?: ApiCallOptions): Promise<ErrorResponse | City[]>;
     /**
      * This method fetches the list of super areas for a given city. A super area is a region of the city in which
      * the TPL service is available at a certain price.

package/lib/booking/tplBooking.js

@@ -76,6 +76,7 @@ var config_1 = require("../config");
 var mtsStorage_1 = require("../mtsStorage");
 var ErrorResponse_1 = require("../types/ErrorResponse");
 var Reduction_1 = require("../types/common/Reduction");
+var SuperArea_1 = require("../types/tpl/SuperArea");
 var processBookingSteps_1 = require("../utils/processBookingSteps");
 var utils_1 = require("../utils/utils");
 var booking_1 = require("./booking");
@@ -220,14 +221,20 @@ var TplBooking = /** @class */ (function (_super) {
     };
     /**
      * This method allows to get the list of cities where it is possible to book a TPL service.
+     * @param request Optional query options (e.g. {@link GetCitiesRequest.type}).
      * @returns An array of {@link City} objects representing the cities where it is possible to book a TPL service
      * if the call is successful, an {@link ErrorResponse} object otherwise.
      */
-    TplBooking.prototype.getCities = function (options) {
+    TplBooking.prototype.getCities = function (request, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var url;
+            var searchParams, url;
             return __generator(this, function (_a) {
-                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/tpl/cities?");
+                searchParams = new URLSearchParams();
+                if ((request === null || request === void 0 ? void 0 : request.type) != null &&
+                    request.type !== SuperArea_1.SuperAreasTypeFilter.ALL) {
+                    searchParams.set("type", request.type);
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/tpl/cities?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.cities;
                     })];

package/lib/index.d.ts

@@ -26,7 +26,7 @@ export { Service, ServiceTrip } from "./types/services/Service";
 export { ServiceCart, ServiceBookingType } from "./types/services/ServiceCart";
 export { ServiceInfo } from "./types/services/ServiceInfo";
 export { GetTariffsResponse } from "./types/tpl/GetTariffsResponse";
-export { SuperArea, GetSuperAreasRequest, SuperAreasTypeFilter } from "./types/tpl/SuperArea";
+export { SuperArea, GetSuperAreasRequest, GetCitiesRequest, SuperAreasTypeFilter } from "./types/tpl/SuperArea";
 export { TplCart, TplBookingType, TplBookingInfo } from "./types/tpl/TplCart";
 export { Subscription } from "./types/subscriptions/Subscriptions";
 export { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse, SubscriptionCalendarDayPeriodInfo } from "./types/subscriptions/SubscriptionAvailabilities";

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

@@ -34,3 +34,13 @@ export type GetSuperAreasRequest = {
      */
     type?: SuperAreasTypeFilter;
 };
+/** Request options for {@link TplBooking.getCities}. */
+export type GetCitiesRequest = {
+    /**
+     * Filters cities by whether they are associated with tour or regular super areas (case-insensitive).
+     * Accepted values: "ALL" (default – no filter applied, all cities are returned; this is also the behaviour when the parameter is omitted),
+     * "TOURS_ONLY" (only cities associated with at least one super area whose tariffs are classified as tours), "REGULAR_ONLY" (only cities associated with at least one super area whose tariffs are classified as regular ticket).
+     * A city can be both a tour city and a regular city if it is associated with super areas of both types.
+     */
+    type?: SuperAreasTypeFilter;
+};

package/package.json

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