Class GuestRoomAgent
java.lang.Object
travel.wink.sdk.travel.agent.model.GuestRoomAgent
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-28T11:55:37.128463507+07:00[Asia/Bangkok]")
public class GuestRoomAgent
extends Object
Guest room details.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumIndicate the type of lifestyle this inventory should be associated with.static enumLevel of expensiveness.static enumUsed to request or specify a gender assignment for a room. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAmenitiesItem(String amenitiesItem) addBedroomConfigurationListItem(BedroomConfigurationAgent bedroomConfigurationListItem) addDescriptionsItem(SimpleDescriptionAgent descriptionsItem) addDisabilityFeaturesItem(String disabilityFeaturesItem) addMultimediasItem(SimpleMultimediaAgent multimediasItem) addRecognitionListItem(TravelInventoryRecognitionAgent recognitionListItem) address(AddressAgent address) addSecurityFeaturesItem(String securityFeaturesItem) addSocialsItem(SocialAgent socialsItem) bathroomCount(Integer bathroomCount) bedroomConfigurationList(List<BedroomConfigurationAgent> bedroomConfigurationList) commissionable(Boolean commissionable) compositeCount(Integer compositeCount) contact(ContactAgent contact) descriptions(List<SimpleDescriptionAgent> descriptions) disabilityFeatures(List<String> disabilityFeatures) booleanfeaturedInd(Boolean featuredInd) @NotNull BooleanModify inventory availability with this flag.@NotNull @Valid AddressAgentGet addressCollection of room amenity items available to the guest.@NotNull @Min(0L) IntegerNumber of bathrooms minimum: 0@NotNull @Valid List<BedroomConfigurationAgent> A room type can have more than one bed configuration.@NotNull BooleanIndicates if this inventory can be added to a booking or if it is read-only marketing material only.@NotNull BooleanIndicate whether sales channels receive commission for selling this inventory.@NotNull BooleanIndicates that the room (suite) is a composite of smaller units.@NotNull @Min(0L) IntegerNumber of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types.@NotNull @Valid ContactAgentGet contact@NotNull @Valid List<SimpleDescriptionAgent> Localized descriptions describing inventory.Supported OTA specification `PHY` code.@NotNull BooleanIndicates whether this inventory is featured.getFloor()Floor an which a room is located@NotNull @Valid UUIDHotel identifier.@NotNull @Valid UUIDUnique record identifier@NotNull @Min(0L) IntegerThe number of pax the room price was meant for minimum: 0@NotNull @Min(0L) IntegerThe number of children the room price was meant for minimum: 0Indicate the type of lifestyle this inventory should be associated with.@NotNull @Min(0L) IntegerNumber of living rooms minimum: 0@NotNull @Valid GeoJsonPointAgentGet location@NotNull @Min(1L) IntegerMaximum number of adults allowed in a room type.@NotNull @Min(0L) IntegerMaximum number of children allowed in a room type.@NotNull @Min(0L) IntegerMaximum number of cribs allowed in a room type.@NotNull @Min(1L) IntegerMaximum number of guest allowed in a room type.@NotNull @Min(0L) IntegerMaximum number of rollaway beds allowed in this room type.Supported OTA specification `AQC` code.@NotNull @Min(1L) IntegerMinimum number of guests allowed in a room type.@NotNull @Valid List<SimpleMultimediaAgent> List of images / videos of inventory.@NotNull StringgetName()Internal name of inventory.@NotNull BooleanNon-smoking indicator@NotNull GuestRoomAgent.PricePointEnumLevel of expensiveness.@NotNull StringSupported OTA specification `PRX` code.@NotNull @Min(1L) IntegerDefines the number of rooms of this type minimum: 1@Valid List<TravelInventoryRecognitionAgent> Inventory-level recognition.@NotNull StringSpecifies the architectural style of a room.@NotNull StringIndicates the category of the room.@NotNull StringSpecifies the room classification (e.g., cabin, apartment).Used to request or specify a gender assignment for a room.@NotNull StringIndicates the location of the room within the hotel structure.@NotNull StringIndicates the view of the room.Supported OTA specification `SEC` code.@NotNull BooleanIf TRUE, the room requires or has sharing available.@NotNull @DecimalMin("1") FloatgetSize()Number of square meters that defines the size of this room type.@Valid List<SocialAgent> Social network accounts for inventory (if applicable).getSort()Use this property to sort an inventory in a list of activities.inthashCode()hotelIdentifier(UUID hotelIdentifier) identifier(UUID identifier) includedAdultOccupancy(Integer includedAdultOccupancy) includedChildOccupancy(Integer includedChildOccupancy) lifestyleType(GuestRoomAgent.LifestyleTypeEnum lifestyleType) livingRoomCount(Integer livingRoomCount) location(GeoJsonPointAgent location) maxAdultOccupancy(Integer maxAdultOccupancy) maxChildOccupancy(Integer maxChildOccupancy) maxOccupancy(Integer maxOccupancy) maxRollaways(Integer maxRollaways) minAgeAppropriateCode(String minAgeAppropriateCode) minOccupancy(Integer minOccupancy) multimedias(List<SimpleMultimediaAgent> multimedias) nonSmoking(Boolean nonSmoking) pricePoint(GuestRoomAgent.PricePointEnum pricePoint) proximityCode(String proximityCode) recognitionList(List<TravelInventoryRecognitionAgent> recognitionList) roomArchitectureCode(String roomArchitectureCode) roomCategory(String roomCategory) roomClassificationCode(String roomClassificationCode) roomGender(GuestRoomAgent.RoomGenderEnum roomGender) roomLocationCode(String roomLocationCode) roomViewCode(String roomViewCode) securityFeatures(List<String> securityFeatures) voidvoidsetAddress(AddressAgent address) voidsetAmenities(List<String> amenities) voidsetBathroomCount(Integer bathroomCount) voidsetBedroomConfigurationList(List<BedroomConfigurationAgent> bedroomConfigurationList) voidsetBookable(Boolean bookable) voidsetCommissionable(Boolean commissionable) voidsetComposite(Boolean composite) voidsetCompositeCount(Integer compositeCount) voidsetContact(ContactAgent contact) voidsetDescriptions(List<SimpleDescriptionAgent> descriptions) voidsetDisabilityFeatures(List<String> disabilityFeatures) voidsetFeaturedInd(Boolean featuredInd) voidvoidsetHotelIdentifier(UUID hotelIdentifier) voidsetIdentifier(UUID identifier) voidsetIncludedAdultOccupancy(Integer includedAdultOccupancy) voidsetIncludedChildOccupancy(Integer includedChildOccupancy) voidsetLifestyleType(GuestRoomAgent.LifestyleTypeEnum lifestyleType) voidsetLivingRoomCount(Integer livingRoomCount) voidsetLocation(GeoJsonPointAgent location) voidsetMaxAdultOccupancy(Integer maxAdultOccupancy) voidsetMaxChildOccupancy(Integer maxChildOccupancy) voidsetMaxCribs(Integer maxCribs) voidsetMaxOccupancy(Integer maxOccupancy) voidsetMaxRollaways(Integer maxRollaways) voidsetMinAgeAppropriateCode(String minAgeAppropriateCode) voidsetMinOccupancy(Integer minOccupancy) voidsetMultimedias(List<SimpleMultimediaAgent> multimedias) voidvoidsetNonSmoking(Boolean nonSmoking) voidsetPricePoint(GuestRoomAgent.PricePointEnum pricePoint) voidsetProximityCode(String proximityCode) voidsetQuantity(Integer quantity) voidsetRecognitionList(List<TravelInventoryRecognitionAgent> recognitionList) voidsetRoomArchitectureCode(String roomArchitectureCode) voidsetRoomCategory(String roomCategory) voidsetRoomClassificationCode(String roomClassificationCode) voidsetRoomGender(GuestRoomAgent.RoomGenderEnum roomGender) voidsetRoomLocationCode(String roomLocationCode) voidsetRoomViewCode(String roomViewCode) voidsetSecurityFeatures(List<String> securityFeatures) voidsetSharedRoomInd(Boolean sharedRoomInd) voidvoidsetSocials(List<SocialAgent> socials) voidsharedRoomInd(Boolean sharedRoomInd) socials(List<SocialAgent> socials) toString()
-
Field Details
-
JSON_PROPERTY_IDENTIFIER
- See Also:
-
JSON_PROPERTY_HOTEL_IDENTIFIER
- See Also:
-
JSON_PROPERTY_FEATURED_IND
- See Also:
-
JSON_PROPERTY_LIFESTYLE_TYPE
- See Also:
-
JSON_PROPERTY_LOCATION
- See Also:
-
JSON_PROPERTY_DESCRIPTIONS
- See Also:
-
JSON_PROPERTY_MULTIMEDIAS
- See Also:
-
JSON_PROPERTY_CONTACT
- See Also:
-
JSON_PROPERTY_ADDRESS
- See Also:
-
JSON_PROPERTY_COMMISSIONABLE
- See Also:
-
JSON_PROPERTY_NAME
- See Also:
-
JSON_PROPERTY_PROXIMITY_CODE
- See Also:
-
JSON_PROPERTY_SORT
- See Also:
-
JSON_PROPERTY_MIN_AGE_APPROPRIATE_CODE
- See Also:
-
JSON_PROPERTY_BOOKABLE
- See Also:
-
JSON_PROPERTY_ACTIVE
- See Also:
-
JSON_PROPERTY_DISABILITY_FEATURES
- See Also:
-
JSON_PROPERTY_SECURITY_FEATURES
- See Also:
-
JSON_PROPERTY_SOCIALS
- See Also:
-
JSON_PROPERTY_PRICE_POINT
- See Also:
-
JSON_PROPERTY_RECOGNITION_LIST
- See Also:
-
JSON_PROPERTY_MAX_OCCUPANCY
- See Also:
-
JSON_PROPERTY_MIN_OCCUPANCY
- See Also:
-
JSON_PROPERTY_QUANTITY
- See Also:
-
JSON_PROPERTY_NON_SMOKING
- See Also:
-
JSON_PROPERTY_BEDROOM_CONFIGURATION_LIST
- See Also:
-
JSON_PROPERTY_SIZE
- See Also:
-
JSON_PROPERTY_MAX_ADULT_OCCUPANCY
- See Also:
-
JSON_PROPERTY_MAX_CHILD_OCCUPANCY
- See Also:
-
JSON_PROPERTY_BATHROOM_COUNT
- See Also:
-
JSON_PROPERTY_LIVING_ROOM_COUNT
- See Also:
-
JSON_PROPERTY_MAX_ROLLAWAYS
- See Also:
-
JSON_PROPERTY_ROOM_CATEGORY
- See Also:
-
JSON_PROPERTY_FLOOR
- See Also:
-
JSON_PROPERTY_ROOM_LOCATION_CODE
- See Also:
-
JSON_PROPERTY_ROOM_VIEW_CODE
- See Also:
-
JSON_PROPERTY_COMPOSITE
- See Also:
-
JSON_PROPERTY_COMPOSITE_COUNT
- See Also:
-
JSON_PROPERTY_ROOM_CLASSIFICATION_CODE
- See Also:
-
JSON_PROPERTY_ROOM_ARCHITECTURE_CODE
- See Also:
-
JSON_PROPERTY_ROOM_GENDER
- See Also:
-
JSON_PROPERTY_SHARED_ROOM_IND
- See Also:
-
JSON_PROPERTY_MAX_CRIBS
- See Also:
-
JSON_PROPERTY_AMENITIES
- See Also:
-
JSON_PROPERTY_INCLUDED_ADULT_OCCUPANCY
- See Also:
-
JSON_PROPERTY_INCLUDED_CHILD_OCCUPANCY
- See Also:
-
-
Constructor Details
-
GuestRoomAgent
public GuestRoomAgent()
-
-
Method Details
-
identifier
-
getIdentifier
Unique record identifier- Returns:
- identifier
-
setIdentifier
-
hotelIdentifier
-
getHotelIdentifier
Hotel identifier.- Returns:
- hotelIdentifier
-
setHotelIdentifier
-
featuredInd
-
getFeaturedInd
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.- Returns:
- featuredInd
-
setFeaturedInd
-
lifestyleType
-
getLifestyleType
Indicate the type of lifestyle this inventory should be associated with.- Returns:
- lifestyleType
-
setLifestyleType
-
location
-
getLocation
Get location- Returns:
- location
-
setLocation
-
descriptions
-
addDescriptionsItem
-
getDescriptions
Localized descriptions describing inventory.- Returns:
- descriptions
-
setDescriptions
-
multimedias
-
addMultimediasItem
-
getMultimedias
List of images / videos of inventory.- Returns:
- multimedias
-
setMultimedias
-
contact
-
getContact
Get contact- Returns:
- contact
-
setContact
-
address
-
getAddress
Get address- Returns:
- address
-
setAddress
-
commissionable
-
getCommissionable
Indicate whether sales channels receive commission for selling this inventory.- Returns:
- commissionable
-
setCommissionable
-
name
-
getName
-
setName
-
proximityCode
-
getProximityCode
Supported OTA specification `PRX` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- proximityCode
-
setProximityCode
-
sort
-
getSort
Use this property to sort an inventory in a list of activities.- Returns:
- sort
-
setSort
-
minAgeAppropriateCode
-
getMinAgeAppropriateCode
Supported OTA specification `AQC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- minAgeAppropriateCode
-
setMinAgeAppropriateCode
-
bookable
-
getBookable
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.- Returns:
- bookable
-
setBookable
-
active
-
getActive
Modify inventory availability with this flag.- Returns:
- active
-
setActive
-
disabilityFeatures
-
addDisabilityFeaturesItem
-
getDisabilityFeatures
-
setDisabilityFeatures
-
securityFeatures
-
addSecurityFeaturesItem
-
getSecurityFeatures
-
setSecurityFeatures
-
addSocialsItem
-
getSocials
Social network accounts for inventory (if applicable).- Returns:
- socials
-
setSocials
-
pricePoint
-
getPricePoint
Level of expensiveness.- Returns:
- pricePoint
-
setPricePoint
-
recognitionList
-
addRecognitionListItem
-
getRecognitionList
Inventory-level recognition.- Returns:
- recognitionList
-
setRecognitionList
-
maxOccupancy
-
getMaxOccupancy
Maximum number of guest allowed in a room type. minimum: 1- Returns:
- maxOccupancy
-
setMaxOccupancy
-
minOccupancy
-
getMinOccupancy
Minimum number of guests allowed in a room type. minimum: 1- Returns:
- minOccupancy
-
setMinOccupancy
-
quantity
-
getQuantity
Defines the number of rooms of this type minimum: 1- Returns:
- quantity
-
setQuantity
-
nonSmoking
-
getNonSmoking
-
setNonSmoking
-
bedroomConfigurationList
public GuestRoomAgent bedroomConfigurationList(List<BedroomConfigurationAgent> bedroomConfigurationList) -
addBedroomConfigurationListItem
public GuestRoomAgent addBedroomConfigurationListItem(BedroomConfigurationAgent bedroomConfigurationListItem) -
getBedroomConfigurationList
@Nonnull @NotNull @Valid public @NotNull @Valid List<BedroomConfigurationAgent> getBedroomConfigurationList()A room type can have more than one bed configuration.- Returns:
- bedroomConfigurationList
-
setBedroomConfigurationList
-
size
-
getSize
Number of square meters that defines the size of this room type. minimum: 1- Returns:
- size
-
setSize
-
maxAdultOccupancy
-
getMaxAdultOccupancy
Maximum number of adults allowed in a room type. minimum: 1- Returns:
- maxAdultOccupancy
-
setMaxAdultOccupancy
-
maxChildOccupancy
-
getMaxChildOccupancy
Maximum number of children allowed in a room type. minimum: 0- Returns:
- maxChildOccupancy
-
setMaxChildOccupancy
-
bathroomCount
-
getBathroomCount
Number of bathrooms minimum: 0- Returns:
- bathroomCount
-
setBathroomCount
-
livingRoomCount
-
getLivingRoomCount
Number of living rooms minimum: 0- Returns:
- livingRoomCount
-
setLivingRoomCount
-
maxRollaways
-
getMaxRollaways
Maximum number of rollaway beds allowed in this room type. minimum: 0- Returns:
- maxRollaways
-
setMaxRollaways
-
roomCategory
-
getRoomCategory
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- roomCategory
-
setRoomCategory
-
floor
-
getFloor
-
setFloor
-
roomLocationCode
-
getRoomLocationCode
Indicates the location of the room within the hotel structure. Typical values would be \"Near Exit\",\"Close to elevator\", \"Low Floor\" or \"High Floor\". Supported OTA specification `RLT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- roomLocationCode
-
setRoomLocationCode
-
roomViewCode
-
getRoomViewCode
Indicates the view of the room. Typical values would be \"Ocean view\", \"Pool view\" or \"Garden View\". Supported OTA specification `RVT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- roomViewCode
-
setRoomViewCode
-
composite
-
getComposite
Indicates that the room (suite) is a composite of smaller units.- Returns:
- composite
-
setComposite
-
compositeCount
-
getCompositeCount
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled. minimum: 0- Returns:
- compositeCount
-
setCompositeCount
-
roomClassificationCode
-
getRoomClassificationCode
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification `GRI` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- roomClassificationCode
-
setRoomClassificationCode
-
roomArchitectureCode
-
getRoomArchitectureCode
Specifies the architectural style of a room. Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)- Returns:
- roomArchitectureCode
-
setRoomArchitectureCode
-
roomGender
-
getRoomGender
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.- Returns:
- roomGender
-
setRoomGender
-
maxCribs
-
getMaxCribs
Maximum number of cribs allowed in a room type. minimum: 0- Returns:
- maxCribs
-
setMaxCribs
-
amenities
-
addAmenitiesItem
-
getAmenities
-
setAmenities
-
includedAdultOccupancy
-
getIncludedAdultOccupancy
The number of pax the room price was meant for minimum: 0- Returns:
- includedAdultOccupancy
-
setIncludedAdultOccupancy
-
includedChildOccupancy
-
getIncludedChildOccupancy
The number of children the room price was meant for minimum: 0- Returns:
- includedChildOccupancy
-
setIncludedChildOccupancy
-
equals
-
hashCode
-
toString
-
socials