@odynn/awayz-hotels 0.6.8 → 0.6.9
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.
|
@@ -1,4 +1,21 @@
|
|
|
1
1
|
import { EAvailabilityAlertStatus } from '../../enums/EAvailabilityAlert';
|
|
2
|
+
/**
|
|
3
|
+
* Represents an availability alert for a hotel.
|
|
4
|
+
* @property id - Unique identifier for the alert.
|
|
5
|
+
* @property hotelName - Name of the hotel.
|
|
6
|
+
* @property hotelId - Unique identifier for the hotel.
|
|
7
|
+
* @property hotelAddress - Address of the hotel.
|
|
8
|
+
* @property hotelImage - Image URL of the hotel.
|
|
9
|
+
* @property checkin - Check-in date (ISO string).
|
|
10
|
+
* @property checkout - Check-out date (ISO string).
|
|
11
|
+
* @property hotelStatus - Current status of the hotel alert.
|
|
12
|
+
* @property hotelGroup - Group or brand of the hotel.
|
|
13
|
+
* @property hotelDescription - Description of the hotel.
|
|
14
|
+
* @property numberOfGuests - Number of guests for the booking.
|
|
15
|
+
* @property numberOfRooms - Number of rooms for the booking.
|
|
16
|
+
* @property archived - Whether the alert is archived.
|
|
17
|
+
* @property acknowledged - Whether the alert has been acknowledged by the user.
|
|
18
|
+
*/
|
|
2
19
|
export interface IAvailabilityAlert {
|
|
3
20
|
id: string;
|
|
4
21
|
hotelName: string;
|
|
@@ -15,6 +32,20 @@ export interface IAvailabilityAlert {
|
|
|
15
32
|
archived: boolean;
|
|
16
33
|
acknowledged: boolean;
|
|
17
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Request payload for creating a new availability alert.
|
|
37
|
+
* @property checkin - Check-in date (ISO string).
|
|
38
|
+
* @property checkout - Check-out date (ISO string).
|
|
39
|
+
* @property hotelGroup - Group or brand of the hotel.
|
|
40
|
+
* @property hotelId - Unique identifier for the hotel.
|
|
41
|
+
* @property name - Name of the hotel.
|
|
42
|
+
* @property hotelImage - Image URL of the hotel.
|
|
43
|
+
* @property hotelAddress - Address of the hotel.
|
|
44
|
+
* @property hotelDescription - Description of the hotel.
|
|
45
|
+
* @property hotelProgramName - Loyalty program name for the hotel.
|
|
46
|
+
* @property numberOfGuests - Number of guests for the booking (optional).
|
|
47
|
+
* @property numberOfRooms - Number of rooms for the booking (optional).
|
|
48
|
+
*/
|
|
18
49
|
export interface ICreateAvailabilityAlertRequest {
|
|
19
50
|
checkin: string;
|
|
20
51
|
checkout: string;
|
|
@@ -28,11 +59,27 @@ export interface ICreateAvailabilityAlertRequest {
|
|
|
28
59
|
numberOfGuests?: number;
|
|
29
60
|
numberOfRooms?: number;
|
|
30
61
|
}
|
|
62
|
+
/**
|
|
63
|
+
* Request payload for updating an existing availability alert.
|
|
64
|
+
* Extends partial properties from ICreateAvailabilityAlertRequest.
|
|
65
|
+
* @property alertId - Unique identifier for the alert to update.
|
|
66
|
+
* @property archived - Whether the alert should be archived (optional).
|
|
67
|
+
* @property acknowledged - Whether the alert should be acknowledged (optional).
|
|
68
|
+
*/
|
|
31
69
|
export interface IUpdateAvailabilityAlertRequest extends Partial<ICreateAvailabilityAlertRequest> {
|
|
32
70
|
alertId: string;
|
|
33
71
|
archived?: boolean;
|
|
34
72
|
acknowledged?: boolean;
|
|
35
73
|
}
|
|
74
|
+
/**
|
|
75
|
+
* Response payload after updating an availability alert.
|
|
76
|
+
* @property alertId - Unique identifier for the alert.
|
|
77
|
+
* @property userId - Unique identifier for the user.
|
|
78
|
+
* @property alertParams - Parameters of the updated alert.
|
|
79
|
+
* @property archived - Whether the alert is archived.
|
|
80
|
+
* @property active - Whether the alert is active.
|
|
81
|
+
* @property batch - Batch number for processing.
|
|
82
|
+
*/
|
|
36
83
|
export interface IUpdateAvailabilityAlertResponse {
|
|
37
84
|
alertId: string;
|
|
38
85
|
userId: string;
|
|
@@ -56,6 +103,21 @@ export interface IUpdateAvailabilityAlertResponse {
|
|
|
56
103
|
active: boolean;
|
|
57
104
|
batch: number;
|
|
58
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Represents a notification for an availability alert.
|
|
108
|
+
* @property id - Unique identifier for the notification.
|
|
109
|
+
* @property hotelName - Name of the hotel.
|
|
110
|
+
* @property hotelId - Unique identifier for the hotel.
|
|
111
|
+
* @property hotelAddress - Address of the hotel.
|
|
112
|
+
* @property hotelImage - Image URL of the hotel.
|
|
113
|
+
* @property checkInDate - Check-in date (ISO string).
|
|
114
|
+
* @property checkOutDate - Check-out date (ISO string).
|
|
115
|
+
* @property hotelGroup - Group or brand of the hotel.
|
|
116
|
+
* @property acknowledged - Whether the notification has been acknowledged.
|
|
117
|
+
* @property hasSentMail - Whether a notification email has been sent.
|
|
118
|
+
* @property numberOfGuests - Number of guests for the booking.
|
|
119
|
+
* @property numberOfRooms - Number of rooms for the booking.
|
|
120
|
+
*/
|
|
59
121
|
export interface IAvailabilityAlertNotification {
|
|
60
122
|
id: string;
|
|
61
123
|
hotelName: string;
|