RoomHistoryItem

public final class RoomHistoryItem

A room history event, representing a change made to a specific room.

Parameters

historyId

Room history id for particular change.

eventTimestamp

Date and time in UTC of the change event, in extended ISO 8601 format.

eventType

Type of event associated with this history item such as modified or canceled. If the booking is marked as a no-show by the property/supplier, the value of event_type is canceled when the include request parameter is history. However, it is canceled_no_show when the include request parameter is history_v2.

eventSource

The source of the event. If voyager_agent, agent_id will be supplied. If the event source is property/supplier, the value of event_source is other when the include request parameter is history. However, it is supplier when the include request parameter is history_v2.

changeReferenceId

Optional identifier provided during changes via Rapid.

agentId

An agent user id number associated with a modification.

roomId

The room id.

confirmationId
bedGroupId

Unique identifier for a bed type.

checkin

The check-in date of the itinerary.

checkout

The check-out date of the itinerary.

numberOfAdults

The number of adults staying in the room.

childAges

The ages of children for the room.

givenName

The first name of the main guest staying in the room.

familyName

The last name of the main guest staying in the room.

status
specialRequest

Any special request info associated with the room.

smoking

Indicates if the room is smoking or non-smoking.

loyaltyId

A loyalty identifier for a hotel loyalty program associated with this room guest.

amountCharged
amountRefunded
penalty
rate

Constructors

Link copied to clipboard
public RoomHistoryItem RoomHistoryItem(String historyId, String eventTimestamp, RoomHistoryItem.EventType eventType, RoomHistoryItem.EventSource eventSource, String changeReferenceId, Integer agentId, String roomId, ConfirmationId confirmationId, String bedGroupId, String checkin, String checkout, BigDecimal numberOfAdults, List<BigDecimal> childAges, String givenName, String familyName, StatusItinerary status, String specialRequest, Boolean smoking, String loyaltyId, Charge amountCharged, Charge amountRefunded, Charge penalty, RateHistory rate)

Types

Link copied to clipboard
public final class Builder
Link copied to clipboard

The source of the event. If voyager_agent, agent_id will be supplied. If the event source is property/supplier, the value of event_source is other when the include request parameter is history. However, it is supplier when the include request parameter is history_v2. Values: RAPID_API,VOYAGER_AGENT,OTHER,SUPPLIER

Link copied to clipboard

Type of event associated with this history item such as modified or canceled. If the booking is marked as a no-show by the property/supplier, the value of event_type is canceled when the include request parameter is history. However, it is canceled_no_show when the include request parameter is history_v2. Values: CREATED,MODIFIED,CANCELED,CANCELED_NO_SHOW

Properties

Link copied to clipboard
@Valid()
private final Integer agentId
Link copied to clipboard
@Valid()
private final Charge amountCharged
Link copied to clipboard
@Valid()
private final Charge amountRefunded
Link copied to clipboard
@Valid()
private final String bedGroupId
Link copied to clipboard
@Valid()
private final String changeReferenceId
Link copied to clipboard
@Valid()
private final String checkin
Link copied to clipboard
@Valid()
private final String checkout
Link copied to clipboard
@Valid()
private final List<BigDecimal> childAges
Link copied to clipboard
@Valid()
private final ConfirmationId confirmationId
Link copied to clipboard
Link copied to clipboard
@Valid()
private final String eventTimestamp
Link copied to clipboard
Link copied to clipboard
@Valid()
private final String familyName
Link copied to clipboard
@Valid()
private final String givenName
Link copied to clipboard
@Valid()
private final String historyId
Link copied to clipboard
@Valid()
private final String loyaltyId
Link copied to clipboard
@Valid()
private final BigDecimal numberOfAdults
Link copied to clipboard
@Valid()
private final Charge penalty
Link copied to clipboard
@Valid()
private final RateHistory rate
Link copied to clipboard
@Valid()
private final String roomId
Link copied to clipboard
@Valid()
private final Boolean smoking
Link copied to clipboard
@Valid()
private final String specialRequest
Link copied to clipboard
@Valid()
private final StatusItinerary status

Functions

Link copied to clipboard
public final static RoomHistoryItem.Builder builder()
Link copied to clipboard
public final Integer getAgentId()
Link copied to clipboard
public final Charge getAmountCharged()
Link copied to clipboard
public final Charge getAmountRefunded()
Link copied to clipboard
public final String getBedGroupId()
Link copied to clipboard
Link copied to clipboard
public final String getCheckin()
Link copied to clipboard
public final String getCheckout()
Link copied to clipboard
public final List<BigDecimal> getChildAges()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
public final String getEventTimestamp()
Link copied to clipboard
Link copied to clipboard
public final String getFamilyName()
Link copied to clipboard
public final String getGivenName()
Link copied to clipboard
public final String getHistoryId()
Link copied to clipboard
public final String getLoyaltyId()
Link copied to clipboard
Link copied to clipboard
public final Charge getPenalty()
Link copied to clipboard
public final RateHistory getRate()
Link copied to clipboard
public final String getRoomId()
Link copied to clipboard
public final Boolean getSmoking()
Link copied to clipboard
public final String getSpecialRequest()
Link copied to clipboard
public final StatusItinerary getStatus()
Link copied to clipboard