mts-booking-library 1.3.15 → 1.3.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/booking/journeyBooking.d.ts +4 -5
- package/lib/booking/journeyBooking.js +2 -3
- package/lib/booking/serviceBooking.d.ts +6 -7
- package/lib/booking/serviceBooking.js +6 -7
- package/lib/booking/subscriptionBooking.d.ts +4 -5
- package/lib/booking/subscriptionBooking.js +5 -6
- package/lib/booking/tplBooking.d.ts +8 -7
- package/lib/booking/tplBooking.js +21 -10
- package/lib/types/common/Person.d.ts +21 -15
- package/lib/types/common/Person.js +1 -1
- package/lib/types/tpl/TplCart.d.ts +6 -6
- package/package.json +1 -1
@@ -1,5 +1,5 @@
|
|
1
1
|
import { ErrorResponse } from "../types/ErrorResponse";
|
2
|
-
import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse
|
2
|
+
import { Buyer, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
|
3
3
|
import { AddReductionRequest } from "../types/common/Reduction";
|
4
4
|
import { BusMatrix } from "../types/journeys/BusMatrix";
|
5
5
|
import { CreateJourneyCartRequest, JourneyCart } from "../types/journeys/JourneyCart";
|
@@ -96,13 +96,12 @@ export declare class JourneyBooking extends Booking {
|
|
96
96
|
getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
|
97
97
|
/**
|
98
98
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
99
|
-
* @param
|
100
|
-
*
|
101
|
-
* @param {string} [phoneNumber=undefined] The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
99
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
|
100
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
102
101
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
103
102
|
* as well as a list of the available tariffs for each trip.
|
104
103
|
*/
|
105
|
-
getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse |
|
104
|
+
getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
|
106
105
|
/**
|
107
106
|
* @description This methosd shall be called when the user wants to update the buyer and the passengers information.
|
108
107
|
* @param {EditPassengersDetailsRequest} passengersDetails The object containing the buyer and the passengers information.
|
@@ -349,9 +349,8 @@ var JourneyBooking = /** @class */ (function (_super) {
|
|
349
349
|
};
|
350
350
|
/**
|
351
351
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
352
|
-
* @param
|
353
|
-
*
|
354
|
-
* @param {string} [phoneNumber=undefined] The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
352
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if phoneNumber is not set.
|
353
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
355
354
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
356
355
|
* as well as a list of the available tariffs for each trip.
|
357
356
|
*/
|
@@ -1,5 +1,5 @@
|
|
1
1
|
import { ErrorResponse } from "../types/ErrorResponse";
|
2
|
-
import {
|
2
|
+
import { Buyer, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
|
3
3
|
import { AddReductionRequest } from "../types/common/Reduction";
|
4
4
|
import { Service, ServiceTripsResponse } from "../types/services/Service";
|
5
5
|
import { CreateServiceCartRequest, ServiceCart } from "../types/services/ServiceCart";
|
@@ -98,20 +98,19 @@ export declare class ServiceBooking extends Booking {
|
|
98
98
|
getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
|
99
99
|
/**
|
100
100
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
101
|
-
* @param
|
102
|
-
*
|
103
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
101
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
102
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
104
103
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
105
104
|
* as well as a list of the available tariffs for each trip.
|
106
105
|
*/
|
107
|
-
getBuyerFromLinkavelCard(
|
106
|
+
getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
|
108
107
|
/**
|
109
108
|
* @description This method shall be called when the user wants to update the buyer information.
|
110
|
-
* @param
|
109
|
+
* @param buyerDetails The object containing the buyer information.
|
111
110
|
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
112
111
|
* @returns An {@link ErrorResponse} object in case of error, true otherwise.
|
113
112
|
*/
|
114
|
-
updateBuyerPassengersDetails(buyerDetails:
|
113
|
+
updateBuyerPassengersDetails(buyerDetails: Buyer | null): Promise<ErrorResponse | boolean>;
|
115
114
|
/**
|
116
115
|
* @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
|
117
116
|
* @param {AddReductionRequest} request The information about the reduction to add
|
@@ -329,13 +329,12 @@ var ServiceBooking = /** @class */ (function (_super) {
|
|
329
329
|
};
|
330
330
|
/**
|
331
331
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
332
|
-
* @param
|
333
|
-
*
|
334
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
332
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
333
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
335
334
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
336
335
|
* as well as a list of the available tariffs for each trip.
|
337
336
|
*/
|
338
|
-
ServiceBooking.prototype.getBuyerFromLinkavelCard = function (
|
337
|
+
ServiceBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
|
339
338
|
return __awaiter(this, void 0, void 0, function () {
|
340
339
|
var buyerPassengersDetails, searchParams, url;
|
341
340
|
return __generator(this, function (_a) {
|
@@ -347,10 +346,10 @@ var ServiceBooking = /** @class */ (function (_super) {
|
|
347
346
|
if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
|
348
347
|
throw Error("The status of the cart does not allow to call this API");
|
349
348
|
}
|
350
|
-
if (!
|
349
|
+
if (!linkavelCard && !phoneNumber) {
|
351
350
|
throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
|
352
351
|
}
|
353
|
-
searchParams = new URLSearchParams(__assign(__assign({}, (
|
352
|
+
searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
|
354
353
|
url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
|
355
354
|
return [2 /*return*/, this.callGetApi(url).then(function (response) {
|
356
355
|
// Check for errors
|
@@ -364,7 +363,7 @@ var ServiceBooking = /** @class */ (function (_super) {
|
|
364
363
|
};
|
365
364
|
/**
|
366
365
|
* @description This method shall be called when the user wants to update the buyer information.
|
367
|
-
* @param
|
366
|
+
* @param buyerDetails The object containing the buyer information.
|
368
367
|
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
369
368
|
* @returns An {@link ErrorResponse} object in case of error, true otherwise.
|
370
369
|
*/
|
@@ -1,5 +1,5 @@
|
|
1
1
|
import { ErrorResponse } from "../types/ErrorResponse";
|
2
|
-
import { EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse
|
2
|
+
import { Buyer, EditPassengersDetailsRequest, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
|
3
3
|
import { AddReductionRequest } from "../types/common/Reduction";
|
4
4
|
import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
|
5
5
|
import { CreateSubscriptionCartRequest, SubscriptionCart } from "../types/subscriptions/SubscriptionCart";
|
@@ -117,13 +117,12 @@ export declare class SubscriptionBooking extends Booking {
|
|
117
117
|
getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
|
118
118
|
/**
|
119
119
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
120
|
-
* @param
|
121
|
-
*
|
122
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
120
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
121
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
123
122
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
124
123
|
* as well as a list of the available tariffs for each trip.
|
125
124
|
*/
|
126
|
-
getBuyerFromLinkavelCard(
|
125
|
+
getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
|
127
126
|
/**
|
128
127
|
* @description This methosd shall be called when the user wants to update the buyer and the passengers information.
|
129
128
|
* @param {EditPassengersDetailsRequest} passengersDetails The object containing the buyer and the passengers information.
|
@@ -408,13 +408,12 @@ var SubscriptionBooking = /** @class */ (function (_super) {
|
|
408
408
|
};
|
409
409
|
/**
|
410
410
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
411
|
-
* @param
|
412
|
-
*
|
413
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
411
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
412
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
414
413
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
415
414
|
* as well as a list of the available tariffs for each trip.
|
416
415
|
*/
|
417
|
-
SubscriptionBooking.prototype.getBuyerFromLinkavelCard = function (
|
416
|
+
SubscriptionBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
|
418
417
|
return __awaiter(this, void 0, void 0, function () {
|
419
418
|
var buyerPassengersDetails, searchParams, url;
|
420
419
|
return __generator(this, function (_a) {
|
@@ -426,10 +425,10 @@ var SubscriptionBooking = /** @class */ (function (_super) {
|
|
426
425
|
if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
|
427
426
|
throw Error("The status of the cart does not allow to call this API");
|
428
427
|
}
|
429
|
-
if (!
|
428
|
+
if (!linkavelCard && !phoneNumber) {
|
430
429
|
throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
|
431
430
|
}
|
432
|
-
searchParams = new URLSearchParams(__assign(__assign({}, (
|
431
|
+
searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
|
433
432
|
url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
|
434
433
|
return [2 /*return*/, this.callGetApi(url).then(function (response) {
|
435
434
|
// Check for errors
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { ErrorResponse } from "../types/ErrorResponse";
|
2
2
|
import { City } from "../types/common/City";
|
3
|
-
import {
|
3
|
+
import { Buyer, GetBuyerPassengersDetailsResponse } from "../types/common/Person";
|
4
4
|
import { AddReductionRequest } from "../types/common/Reduction";
|
5
5
|
import { TariffType, TermsType } from "../types/common/Tariffs";
|
6
6
|
import { GetTariffsResponse } from "../types/tpl/GetTariffsResponse";
|
@@ -118,20 +118,21 @@ export declare class TplBooking extends Booking {
|
|
118
118
|
getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
|
119
119
|
/**
|
120
120
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
121
|
-
* @param
|
122
|
-
*
|
123
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
121
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
122
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
124
123
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
125
124
|
* as well as a list of the available tariffs for each trip.
|
126
125
|
*/
|
127
|
-
getBuyerFromLinkavelCard(
|
126
|
+
getBuyerFromLinkavelCard(linkavelCard?: string, phoneNumber?: string): Promise<ErrorResponse | Buyer>;
|
128
127
|
/**
|
129
128
|
* @description This method shall be called when the user wants to update the buyer information.
|
130
|
-
* @param
|
129
|
+
* @param buyerDetails The object containing the buyer information.
|
131
130
|
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
131
|
+
* @param subscriptionPersonCode The person code of the passenger that is associated
|
132
|
+
* with the subscription. This parameter is required if the cart contains a subscription.
|
132
133
|
* @returns An {@link ErrorResponse} object in case of error, true otherwise.
|
133
134
|
*/
|
134
|
-
updateBuyerPassengersDetails(buyerDetails:
|
135
|
+
updateBuyerPassengersDetails(buyerDetails: Buyer | null, subscriptionPersonCode?: string): Promise<ErrorResponse | boolean>;
|
135
136
|
/**
|
136
137
|
* @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
|
137
138
|
* @param {AddReductionRequest} request The information about the reduction to add
|
@@ -381,7 +381,7 @@ var TplBooking = /** @class */ (function (_super) {
|
|
381
381
|
return {
|
382
382
|
buyerDataStatus: response.buyerDataStatus,
|
383
383
|
buyer: response.buyer,
|
384
|
-
passengers:
|
384
|
+
passengers: null
|
385
385
|
};
|
386
386
|
})];
|
387
387
|
});
|
@@ -389,13 +389,12 @@ var TplBooking = /** @class */ (function (_super) {
|
|
389
389
|
};
|
390
390
|
/**
|
391
391
|
* @description This method shall be called when the user wants to retrieve information about an esisting buyer.
|
392
|
-
* @param
|
393
|
-
*
|
394
|
-
* @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
|
392
|
+
* @param linkavelCard The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
|
393
|
+
* @param phoneNumber The phone number of the buyer. This parameter is required if linkavelCard is not set.
|
395
394
|
* @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
|
396
395
|
* as well as a list of the available tariffs for each trip.
|
397
396
|
*/
|
398
|
-
TplBooking.prototype.getBuyerFromLinkavelCard = function (
|
397
|
+
TplBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCard, phoneNumber) {
|
399
398
|
return __awaiter(this, void 0, void 0, function () {
|
400
399
|
var buyerPassengersDetails, searchParams, url;
|
401
400
|
return __generator(this, function (_a) {
|
@@ -407,10 +406,10 @@ var TplBooking = /** @class */ (function (_super) {
|
|
407
406
|
if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
|
408
407
|
throw Error("The status of the cart does not allow to call this API");
|
409
408
|
}
|
410
|
-
if (!
|
409
|
+
if (!linkavelCard && !phoneNumber) {
|
411
410
|
throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
|
412
411
|
}
|
413
|
-
searchParams = new URLSearchParams(__assign(__assign({}, (
|
412
|
+
searchParams = new URLSearchParams(__assign(__assign({}, (linkavelCard && { linkavelCard: linkavelCard })), (phoneNumber && { phoneNumber: phoneNumber })));
|
414
413
|
url = "".concat(this.config.API_ENDPOINT, "/v3_resources/buyers?").concat(searchParams);
|
415
414
|
return [2 /*return*/, this.callGetApi(url).then(function (response) {
|
416
415
|
// Check for errors
|
@@ -424,11 +423,13 @@ var TplBooking = /** @class */ (function (_super) {
|
|
424
423
|
};
|
425
424
|
/**
|
426
425
|
* @description This method shall be called when the user wants to update the buyer information.
|
427
|
-
* @param
|
426
|
+
* @param buyerDetails The object containing the buyer information.
|
428
427
|
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
428
|
+
* @param subscriptionPersonCode The person code of the passenger that is associated
|
429
|
+
* with the subscription. This parameter is required if the cart contains a subscription.
|
429
430
|
* @returns An {@link ErrorResponse} object in case of error, true otherwise.
|
430
431
|
*/
|
431
|
-
TplBooking.prototype.updateBuyerPassengersDetails = function (buyerDetails) {
|
432
|
+
TplBooking.prototype.updateBuyerPassengersDetails = function (buyerDetails, subscriptionPersonCode) {
|
432
433
|
return __awaiter(this, void 0, void 0, function () {
|
433
434
|
var buyerPassengersDetails, request, url;
|
434
435
|
var _this = this;
|
@@ -437,13 +438,23 @@ var TplBooking = /** @class */ (function (_super) {
|
|
437
438
|
if (!this.cart) {
|
438
439
|
throw Error("Cart is not initialized yet");
|
439
440
|
}
|
441
|
+
if (this.cart.bookings.some(function (b) { return b.info.isSubscription && b.type === TplBooking.BookingTypes.TPL; }) &&
|
442
|
+
!subscriptionPersonCode) {
|
443
|
+
throw Error("The subscriptionPersonCode is required when updating a subscription");
|
444
|
+
}
|
440
445
|
buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
|
441
446
|
if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
|
442
447
|
throw Error("The status of the cart does not allow to call this API");
|
443
448
|
}
|
444
449
|
request = {
|
445
450
|
buyer: buyerDetails,
|
446
|
-
passengers:
|
451
|
+
passengers: subscriptionPersonCode
|
452
|
+
? [
|
453
|
+
{
|
454
|
+
personCode: subscriptionPersonCode
|
455
|
+
}
|
456
|
+
]
|
457
|
+
: []
|
447
458
|
};
|
448
459
|
url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/").concat(this.cart.id, "/details");
|
449
460
|
return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
|
@@ -1,22 +1,27 @@
|
|
1
1
|
import { PassengerTariff } from "./Tariffs";
|
2
2
|
/**
|
3
3
|
* @description Represents a person, that can be a passenger or the buyer.
|
4
|
-
*
|
5
|
-
* @property {number} id - The unique identifier for the person.
|
6
|
-
* @property {string} name - The name of the person.
|
7
|
-
* @property {string} lastName - The last name of the person.
|
8
|
-
* @property {string} email - The email of the person.
|
9
|
-
* @property {string} phoneNumber - The phone number of the person.
|
10
|
-
* @property {string} [notes=undefined] - The notes for this person.
|
11
4
|
*/
|
12
5
|
export type Person = {
|
6
|
+
/** The unique identifier for the person. */
|
13
7
|
id: number;
|
8
|
+
/** The name of the person. */
|
14
9
|
name: string;
|
10
|
+
/** The last name of the person. */
|
15
11
|
lastName: string;
|
12
|
+
/** The email of the person. */
|
16
13
|
email: string;
|
14
|
+
/** The phone number of the person. */
|
17
15
|
phoneNumber: string;
|
16
|
+
/** The person code of the person. */
|
17
|
+
personCode?: string;
|
18
|
+
/** The notes for this person. */
|
18
19
|
notes?: string;
|
19
20
|
};
|
21
|
+
export type Buyer = Person & {
|
22
|
+
/** The social security number of the buyer, if provided. */
|
23
|
+
socialSecurityNumber: string | null;
|
24
|
+
};
|
20
25
|
export declare const DEFAULT_PERSON: Person;
|
21
26
|
export declare const initializePerson: (person?: Person | undefined | null) => Person;
|
22
27
|
/**
|
@@ -51,9 +56,9 @@ export type GetBuyerPassengersDetailsResponse = {
|
|
51
56
|
/** Whether the form for the buyer data is required, optional or cannot be specified. */
|
52
57
|
buyerDataStatus: BuyerDataStatus;
|
53
58
|
/** The {@link Person} object representing the buyer. */
|
54
|
-
buyer:
|
59
|
+
buyer: Buyer | null;
|
55
60
|
/** An array of {@link GetPassenger} objects representing the passengers. */
|
56
|
-
passengers: GetPassenger[];
|
61
|
+
passengers: GetPassenger[] | null;
|
57
62
|
};
|
58
63
|
/**
|
59
64
|
* @description Represents the type of the passengers array in {@link EditPassengersDetailsRequest}.
|
@@ -67,13 +72,14 @@ export type EditPassengerRequestType = Person & {
|
|
67
72
|
};
|
68
73
|
/**
|
69
74
|
* @description Represents the passengers details.
|
70
|
-
* This type shall be used as request for the {@link
|
71
|
-
*
|
72
|
-
* @property {EditPassengerRequestType[]} passengers - An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers.
|
73
|
-
* @property {Person | null} buyer - The {@link Person} object representing the buyer.
|
74
|
-
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
75
|
+
* This type shall be used as request for the {@link Booking.updateBuyerPassengersDetails} method.
|
75
76
|
*/
|
76
77
|
export type EditPassengersDetailsRequest = {
|
78
|
+
/** An array of {@link Person} extended by the map `tripsToTariffs` objects representing the passengers. */
|
77
79
|
passengers: EditPassengerRequestType[];
|
78
|
-
|
80
|
+
/**
|
81
|
+
* The {@link Person} object representing the buyer.
|
82
|
+
* It should be null if the buyer data cannot be specified (see {@link GetBuyerPassengersDetailsResponse.buyerDataStatus}).
|
83
|
+
*/
|
84
|
+
buyer: Buyer | null;
|
79
85
|
};
|
@@ -1,9 +1,9 @@
|
|
1
1
|
"use strict";
|
2
|
-
// This module contains the types to manage the passengers information
|
3
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
4
3
|
exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = void 0;
|
5
4
|
exports.DEFAULT_PERSON = {
|
6
5
|
id: 0,
|
6
|
+
personCode: "",
|
7
7
|
name: "",
|
8
8
|
lastName: "",
|
9
9
|
email: "",
|
@@ -26,16 +26,16 @@ export type TplBookingType = {
|
|
26
26
|
};
|
27
27
|
/**
|
28
28
|
* @description Represents a `TplBookingInfo`, which contains general information about a tpl booking.
|
29
|
-
* @property {boolean} isSubscription - Whether the booking is a subscription or a single ticket.
|
30
|
-
* @property {number} superAreaId - The id of the super area.
|
31
|
-
* @property {number} validity - The validity of the ticket (or of the subscription).
|
32
|
-
* @property {string} startDate - The start date of the ticket (or of the subscription).
|
33
|
-
* @property {string} endDate - The end date of the ticket (or of the subscription).
|
34
29
|
*/
|
35
30
|
export type TplBookingInfo = {
|
31
|
+
/** Whether the booking is a subscription or a single ticket. */
|
36
32
|
isSubscription: boolean;
|
33
|
+
/** The id of the super area. */
|
37
34
|
superAreaId: number;
|
38
|
-
validity
|
35
|
+
/** The validity of the ticket (or of the subscription). */
|
36
|
+
validity: string;
|
37
|
+
/** The start date of the ticket (or of the subscription). */
|
39
38
|
startDate: string;
|
39
|
+
/** The end date of the ticket (or of the subscription). */
|
40
40
|
endDate: string;
|
41
41
|
};
|