Class EngineConfigurationBookingReportAgent

java.lang.Object

travel.wink.sdk.travel.agent.model.EngineConfigurationBookingReportAgent

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-03-04T20:50:59.267991942+07:00[Asia/Bangkok]")
public class EngineConfigurationBookingReportAgent
extends Object

Which engine configuration record did the entity application used to facilitate in making this booking happen.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EngineConfigurationBookingReportAgent.CardDesignEnum	Choose the card design to use on our web component cards.
static enum	EngineConfigurationBookingReportAgent.CardLayoutEnum	Choose how you large you want our web component cards to be.
static enum	EngineConfigurationBookingReportAgent.DefaultLifestyleEnum	Control which lifestyle contextx your users see initially.
static enum	EngineConfigurationBookingReportAgent.LayoutEnum	Choose how you want our web component cards laid out.
static enum	EngineConfigurationBookingReportAgent.SubTypeEnum	Sales channel sub-type.
static enum	EngineConfigurationBookingReportAgent.WcBookClickActionEnum	Action to complete once a user clicks on the CTA button on blocking.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CARD_DESIGN
static final String	JSON_PROPERTY_CARD_LAYOUT
static final String	JSON_PROPERTY_CITY
static final String	JSON_PROPERTY_DEFAULT_CURRENCY
static final String	JSON_PROPERTY_DEFAULT_LANGUAGE
static final String	JSON_PROPERTY_DEFAULT_LIFESTYLE
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_HOSTED_BOOKING_ENGINE_URL
static final String	JSON_PROPERTY_IDENTIFIER
static final String	JSON_PROPERTY_LAYOUT
static final String	JSON_PROPERTY_LOGOS
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_NUMBER_OF_ADVANCE_DAYS
static final String	JSON_PROPERTY_NUMBER_OF_STAY_DAYS
static final String	JSON_PROPERTY_OWNER_IDENTIFIER
static final String	JSON_PROPERTY_OWNER_NAME
static final String	JSON_PROPERTY_PROMOTIONAL_CODES
static final String	JSON_PROPERTY_ROOM_CONFIGURATIONS
static final String	JSON_PROPERTY_SELF_HOSTED
static final String	JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_BOOKER
static final String	JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_CHANNEL_MANAGER
static final String	JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_PROPERTY
static final String	JSON_PROPERTY_SHOW_RANKINGS
static final String	JSON_PROPERTY_SHOW_SEARCH
static final String	JSON_PROPERTY_SHOW_UNAVAILABLE_CARD
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_SUB_TYPE
static final String	JSON_PROPERTY_THEME_COLORS
static final String	JSON_PROPERTY_USE_DAYS
static final String	JSON_PROPERTY_USER_IDENTIFIER
static final String	JSON_PROPERTY_WC_BOOK_CLICK_ACTION

Constructor Summary

Constructors

Constructor	Description
EngineConfigurationBookingReportAgent()

Method Summary

Modifier and Type	Method	Description
EngineConfigurationBookingReportAgent	addLogosItem(SimpleMultimediaAgent logosItem)
EngineConfigurationBookingReportAgent	addPromotionalCodesItem(String promotionalCodesItem)
EngineConfigurationBookingReportAgent	addRoomConfigurationsItem(RoomConfigurationAgent roomConfigurationsItem)
EngineConfigurationBookingReportAgent	cardDesign(EngineConfigurationBookingReportAgent.CardDesignEnum cardDesign)
EngineConfigurationBookingReportAgent	cardLayout(EngineConfigurationBookingReportAgent.CardLayoutEnum cardLayout)
EngineConfigurationBookingReportAgent	city(GeoNameAgent city)
EngineConfigurationBookingReportAgent	defaultCurrency(String defaultCurrency)
EngineConfigurationBookingReportAgent	defaultLanguage(String defaultLanguage)
EngineConfigurationBookingReportAgent	defaultLifestyle(EngineConfigurationBookingReportAgent.DefaultLifestyleEnum defaultLifestyle)
EngineConfigurationBookingReportAgent	endDate(LocalDate endDate)
boolean	equals(Object o)
EngineConfigurationBookingReportAgent.CardDesignEnum	getCardDesign()	Choose the card design to use on our web component cards.
EngineConfigurationBookingReportAgent.CardLayoutEnum	getCardLayout()	Choose how you large you want our web component cards to be.
@Valid GeoNameAgent	getCity()	Get city
String	getDefaultCurrency()	Control which currency your users see prices in initially.
String	getDefaultLanguage()	Control which language your users see text in initially.
EngineConfigurationBookingReportAgent.DefaultLifestyleEnum	getDefaultLifestyle()	Control which lifestyle contextx your users see initially.
@Valid LocalDate	getEndDate()	Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date.
String	getHostedBookingEngineUrl()	If you are self-hosting our booking engine, let us know where it is hosted.
@NotNull @Valid UUID	getIdentifier()	Unique engine configuration identifier
EngineConfigurationBookingReportAgent.LayoutEnum	getLayout()	Choose how you want our web component cards laid out.
@Valid List<SimpleMultimediaAgent>	getLogos()	Customize booking confirmation emails by adding a custom logo to your configuration.
@NotNull String	getName()	Engine configuration name
Integer	getNumberOfAdvanceDays()	You can control the initial itinerary date used to retrieve travel blocking prices.
Integer	getNumberOfStayDays()	You can control the initial itinerary date used to retrieve travel blocking prices.
@NotNull @Valid UUID	getOwnerIdentifier()	Engine configuration record creator identifier
@NotNull String	getOwnerName()	Name of company owner.
List<String>	getPromotionalCodes()	If you've received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.
@Valid List<RoomConfigurationAgent>	getRoomConfigurations()	Control how many adults / children will be staying and how many rooms.
Boolean	getSelfHosted()	Flag to indicate you are self-hosting our booking engine and not using our default booking engine url.
Boolean	getSendBookingNotificationEmailsToBooker()	An integrator can choose to disable outgoing emails to users because they want to do that themselves.
Boolean	getSendBookingNotificationEmailsToChannelManager()	An integrator can choose to disable notifying the property's channel manager.
Boolean	getSendBookingNotificationEmailsToProperty()	An integrator can choose to disable outgoing emails to properties because they want to do that themselves.
Boolean	getShowRankings()	Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.
Boolean	getShowSearch()	This feature flag controls whether to let a user move away from the hotel landing page using search.
Boolean	getShowUnavailableCard()	Show unavailable blocking card when blocking not currently for sale.
@Valid LocalDate	getStartDate()	Set a fixed itinerary start date.
@NotNull EngineConfigurationBookingReportAgent.SubTypeEnum	getSubType()	Sales channel sub-type.
@Valid EngineConfigurationThemeColorsAgent	getThemeColors()	Get themeColors
Boolean	getUseDays()	if true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate
@NotNull @Valid UUID	getUserIdentifier()	Authenticated user identifier
EngineConfigurationBookingReportAgent.WcBookClickActionEnum	getWcBookClickAction()	Action to complete once a user clicks on the CTA button on blocking.
int	hashCode()
EngineConfigurationBookingReportAgent	hostedBookingEngineUrl(String hostedBookingEngineUrl)
EngineConfigurationBookingReportAgent	identifier(UUID identifier)
EngineConfigurationBookingReportAgent	layout(EngineConfigurationBookingReportAgent.LayoutEnum layout)
EngineConfigurationBookingReportAgent	logos(List<SimpleMultimediaAgent> logos)
EngineConfigurationBookingReportAgent	name(String name)
EngineConfigurationBookingReportAgent	numberOfAdvanceDays(Integer numberOfAdvanceDays)
EngineConfigurationBookingReportAgent	numberOfStayDays(Integer numberOfStayDays)
EngineConfigurationBookingReportAgent	ownerIdentifier(UUID ownerIdentifier)
EngineConfigurationBookingReportAgent	ownerName(String ownerName)
EngineConfigurationBookingReportAgent	promotionalCodes(List<String> promotionalCodes)
EngineConfigurationBookingReportAgent	roomConfigurations(List<RoomConfigurationAgent> roomConfigurations)
EngineConfigurationBookingReportAgent	selfHosted(Boolean selfHosted)
EngineConfigurationBookingReportAgent	sendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker)
EngineConfigurationBookingReportAgent	sendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager)
EngineConfigurationBookingReportAgent	sendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty)
void	setCardDesign(EngineConfigurationBookingReportAgent.CardDesignEnum cardDesign)
void	setCardLayout(EngineConfigurationBookingReportAgent.CardLayoutEnum cardLayout)
void	setCity(GeoNameAgent city)
void	setDefaultCurrency(String defaultCurrency)
void	setDefaultLanguage(String defaultLanguage)
void	setDefaultLifestyle(EngineConfigurationBookingReportAgent.DefaultLifestyleEnum defaultLifestyle)
void	setEndDate(LocalDate endDate)
void	setHostedBookingEngineUrl(String hostedBookingEngineUrl)
void	setIdentifier(UUID identifier)
void	setLayout(EngineConfigurationBookingReportAgent.LayoutEnum layout)
void	setLogos(List<SimpleMultimediaAgent> logos)
void	setName(String name)
void	setNumberOfAdvanceDays(Integer numberOfAdvanceDays)
void	setNumberOfStayDays(Integer numberOfStayDays)
void	setOwnerIdentifier(UUID ownerIdentifier)
void	setOwnerName(String ownerName)
void	setPromotionalCodes(List<String> promotionalCodes)
void	setRoomConfigurations(List<RoomConfigurationAgent> roomConfigurations)
void	setSelfHosted(Boolean selfHosted)
void	setSendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker)
void	setSendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager)
void	setSendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty)
void	setShowRankings(Boolean showRankings)
void	setShowSearch(Boolean showSearch)
void	setShowUnavailableCard(Boolean showUnavailableCard)
void	setStartDate(LocalDate startDate)
void	setSubType(EngineConfigurationBookingReportAgent.SubTypeEnum subType)
void	setThemeColors(EngineConfigurationThemeColorsAgent themeColors)
void	setUseDays(Boolean useDays)
void	setUserIdentifier(UUID userIdentifier)
void	setWcBookClickAction(EngineConfigurationBookingReportAgent.WcBookClickActionEnum wcBookClickAction)
EngineConfigurationBookingReportAgent	showRankings(Boolean showRankings)
EngineConfigurationBookingReportAgent	showSearch(Boolean showSearch)
EngineConfigurationBookingReportAgent	showUnavailableCard(Boolean showUnavailableCard)
EngineConfigurationBookingReportAgent	startDate(LocalDate startDate)
EngineConfigurationBookingReportAgent	subType(EngineConfigurationBookingReportAgent.SubTypeEnum subType)
EngineConfigurationBookingReportAgent	themeColors(EngineConfigurationThemeColorsAgent themeColors)
String	toString()
EngineConfigurationBookingReportAgent	useDays(Boolean useDays)
EngineConfigurationBookingReportAgent	userIdentifier(UUID userIdentifier)
EngineConfigurationBookingReportAgent	wcBookClickAction(EngineConfigurationBookingReportAgent.WcBookClickActionEnum wcBookClickAction)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_IDENTIFIER

public static final String JSON_PROPERTY_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_USER_IDENTIFIER

public static final String JSON_PROPERTY_USER_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_OWNER_IDENTIFIER

public static final String JSON_PROPERTY_OWNER_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_OWNER_NAME

public static final String JSON_PROPERTY_OWNER_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_SUB_TYPE

public static final String JSON_PROPERTY_SUB_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_DEFAULT_CURRENCY

public static final String JSON_PROPERTY_DEFAULT_CURRENCY

See Also:

• Constant Field Values

JSON_PROPERTY_DEFAULT_LANGUAGE

public static final String JSON_PROPERTY_DEFAULT_LANGUAGE

See Also:

• Constant Field Values

JSON_PROPERTY_DEFAULT_LIFESTYLE

public static final String JSON_PROPERTY_DEFAULT_LIFESTYLE

See Also:

• Constant Field Values

JSON_PROPERTY_LOGOS

public static final String JSON_PROPERTY_LOGOS

See Also:

• Constant Field Values

JSON_PROPERTY_HOSTED_BOOKING_ENGINE_URL

public static final String JSON_PROPERTY_HOSTED_BOOKING_ENGINE_URL

See Also:

• Constant Field Values

JSON_PROPERTY_SELF_HOSTED

public static final String JSON_PROPERTY_SELF_HOSTED

See Also:

• Constant Field Values

JSON_PROPERTY_THEME_COLORS

public static final String JSON_PROPERTY_THEME_COLORS

See Also:

• Constant Field Values

JSON_PROPERTY_CARD_LAYOUT

public static final String JSON_PROPERTY_CARD_LAYOUT

See Also:

• Constant Field Values

JSON_PROPERTY_LAYOUT

public static final String JSON_PROPERTY_LAYOUT

See Also:

• Constant Field Values

JSON_PROPERTY_CARD_DESIGN

public static final String JSON_PROPERTY_CARD_DESIGN

See Also:

• Constant Field Values

JSON_PROPERTY_NUMBER_OF_ADVANCE_DAYS

public static final String JSON_PROPERTY_NUMBER_OF_ADVANCE_DAYS

See Also:

• Constant Field Values

JSON_PROPERTY_NUMBER_OF_STAY_DAYS

public static final String JSON_PROPERTY_NUMBER_OF_STAY_DAYS

See Also:

• Constant Field Values

JSON_PROPERTY_START_DATE

public static final String JSON_PROPERTY_START_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_END_DATE

public static final String JSON_PROPERTY_END_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_ROOM_CONFIGURATIONS

public static final String JSON_PROPERTY_ROOM_CONFIGURATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_USE_DAYS

public static final String JSON_PROPERTY_USE_DAYS

See Also:

• Constant Field Values

JSON_PROPERTY_PROMOTIONAL_CODES

public static final String JSON_PROPERTY_PROMOTIONAL_CODES

See Also:

• Constant Field Values

JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_PROPERTY

public static final String JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_PROPERTY

See Also:

• Constant Field Values

JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_BOOKER

public static final String JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_BOOKER

See Also:

• Constant Field Values

JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_CHANNEL_MANAGER

public static final String JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_CHANNEL_MANAGER

See Also:

• Constant Field Values

JSON_PROPERTY_WC_BOOK_CLICK_ACTION

public static final String JSON_PROPERTY_WC_BOOK_CLICK_ACTION

See Also:

• Constant Field Values

JSON_PROPERTY_CITY

public static final String JSON_PROPERTY_CITY

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_UNAVAILABLE_CARD

public static final String JSON_PROPERTY_SHOW_UNAVAILABLE_CARD

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_RANKINGS

public static final String JSON_PROPERTY_SHOW_RANKINGS

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_SEARCH

public static final String JSON_PROPERTY_SHOW_SEARCH

See Also:

• Constant Field Values

Constructor Details

EngineConfigurationBookingReportAgent

public EngineConfigurationBookingReportAgent()

Method Details

identifier

public EngineConfigurationBookingReportAgent identifier(UUID identifier)

getIdentifier

@Nonnull
@NotNull
@Valid
public @NotNull @Valid UUID getIdentifier()

Unique engine configuration identifier

Returns:

identifier

setIdentifier

public void setIdentifier(UUID identifier)

name

public EngineConfigurationBookingReportAgent name(String name)

getName

@Nonnull
@NotNull
public @NotNull String getName()

Engine configuration name

Returns:

name

setName

public void setName(String name)

userIdentifier

public EngineConfigurationBookingReportAgent userIdentifier(UUID userIdentifier)

getUserIdentifier

@Nonnull
@NotNull
@Valid
public @NotNull @Valid UUID getUserIdentifier()

Authenticated user identifier

Returns:

userIdentifier

setUserIdentifier

public void setUserIdentifier(UUID userIdentifier)

ownerIdentifier

public EngineConfigurationBookingReportAgent ownerIdentifier(UUID ownerIdentifier)

getOwnerIdentifier

@Nonnull
@NotNull
@Valid
public @NotNull @Valid UUID getOwnerIdentifier()

Engine configuration record creator identifier

Returns:

ownerIdentifier

setOwnerIdentifier

public void setOwnerIdentifier(UUID ownerIdentifier)

ownerName

public EngineConfigurationBookingReportAgent ownerName(String ownerName)

getOwnerName

@Nonnull
@NotNull
public @NotNull String getOwnerName()

Name of company owner.

Returns:

ownerName

setOwnerName

public void setOwnerName(String ownerName)

subType

public EngineConfigurationBookingReportAgent subType(EngineConfigurationBookingReportAgent.SubTypeEnum subType)

getSubType

@Nonnull
@NotNull
public @NotNull EngineConfigurationBookingReportAgent.SubTypeEnum getSubType()

Sales channel sub-type.

Returns:

subType

setSubType

public void setSubType(EngineConfigurationBookingReportAgent.SubTypeEnum subType)

defaultCurrency

public EngineConfigurationBookingReportAgent defaultCurrency(String defaultCurrency)

getDefaultCurrency

@Nullable
public String getDefaultCurrency()

Control which currency your users see prices in initially.

Returns:

defaultCurrency

setDefaultCurrency

public void setDefaultCurrency(String defaultCurrency)

defaultLanguage

public EngineConfigurationBookingReportAgent defaultLanguage(String defaultLanguage)

getDefaultLanguage

@Nullable
public String getDefaultLanguage()

Control which language your users see text in initially.

Returns:

defaultLanguage

setDefaultLanguage

public void setDefaultLanguage(String defaultLanguage)

defaultLifestyle

public EngineConfigurationBookingReportAgent defaultLifestyle(EngineConfigurationBookingReportAgent.DefaultLifestyleEnum defaultLifestyle)

getDefaultLifestyle

@Nullable
public EngineConfigurationBookingReportAgent.DefaultLifestyleEnum getDefaultLifestyle()

Control which lifestyle contextx your users see initially.

Returns:

defaultLifestyle

setDefaultLifestyle

public void setDefaultLifestyle(EngineConfigurationBookingReportAgent.DefaultLifestyleEnum defaultLifestyle)

logos

public EngineConfigurationBookingReportAgent logos(List<SimpleMultimediaAgent> logos)

addLogosItem

public EngineConfigurationBookingReportAgent addLogosItem(SimpleMultimediaAgent logosItem)

getLogos

@Nullable
@Valid
public @Valid List<SimpleMultimediaAgent> getLogos()

Customize booking confirmation emails by adding a custom logo to your configuration.

Returns:

logos

setLogos

public void setLogos(List<SimpleMultimediaAgent> logos)

hostedBookingEngineUrl

public EngineConfigurationBookingReportAgent hostedBookingEngineUrl(String hostedBookingEngineUrl)

getHostedBookingEngineUrl

@Nullable
public String getHostedBookingEngineUrl()

If you are self-hosting our booking engine, let us know where it is hosted. Note: This url needs to be secured with SSL.

Returns:

hostedBookingEngineUrl

setHostedBookingEngineUrl

public void setHostedBookingEngineUrl(String hostedBookingEngineUrl)

selfHosted

public EngineConfigurationBookingReportAgent selfHosted(Boolean selfHosted)

getSelfHosted

@Nullable
public Boolean getSelfHosted()

Flag to indicate you are self-hosting our booking engine and not using our default booking engine url.

Returns:

selfHosted

setSelfHosted

public void setSelfHosted(Boolean selfHosted)

themeColors

public EngineConfigurationBookingReportAgent themeColors(EngineConfigurationThemeColorsAgent themeColors)

getThemeColors

@Nullable
@Valid
public @Valid EngineConfigurationThemeColorsAgent getThemeColors()

Get themeColors

Returns:

themeColors

setThemeColors

public void setThemeColors(EngineConfigurationThemeColorsAgent themeColors)

cardLayout

public EngineConfigurationBookingReportAgent cardLayout(EngineConfigurationBookingReportAgent.CardLayoutEnum cardLayout)

getCardLayout

@Nullable
public EngineConfigurationBookingReportAgent.CardLayoutEnum getCardLayout()

Choose how you large you want our web component cards to be.

Returns:

cardLayout

setCardLayout

public void setCardLayout(EngineConfigurationBookingReportAgent.CardLayoutEnum cardLayout)

layout

public EngineConfigurationBookingReportAgent layout(EngineConfigurationBookingReportAgent.LayoutEnum layout)

getLayout

@Nullable
public EngineConfigurationBookingReportAgent.LayoutEnum getLayout()

Choose how you want our web component cards laid out.

Returns:

layout

setLayout

public void setLayout(EngineConfigurationBookingReportAgent.LayoutEnum layout)

cardDesign

public EngineConfigurationBookingReportAgent cardDesign(EngineConfigurationBookingReportAgent.CardDesignEnum cardDesign)

getCardDesign

@Nullable
public EngineConfigurationBookingReportAgent.CardDesignEnum getCardDesign()

Choose the card design to use on our web component cards.

Returns:

cardDesign

setCardDesign

public void setCardDesign(EngineConfigurationBookingReportAgent.CardDesignEnum cardDesign)

numberOfAdvanceDays

public EngineConfigurationBookingReportAgent numberOfAdvanceDays(Integer numberOfAdvanceDays)

getNumberOfAdvanceDays

@Nullable
public Integer getNumberOfAdvanceDays()

You can control the initial itinerary date used to retrieve travel blocking prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long and how many days in advance (this field), of today's date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don't use either of these options, the itinerary will default to today's date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave `startDate` and `endDate` empty.

Returns:

numberOfAdvanceDays

setNumberOfAdvanceDays

public void setNumberOfAdvanceDays(Integer numberOfAdvanceDays)

numberOfStayDays

public EngineConfigurationBookingReportAgent numberOfStayDays(Integer numberOfStayDays)

getNumberOfStayDays

@Nullable
public Integer getNumberOfStayDays()

You can control the initial itinerary date used to retrieve travel blocking prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long (this field) and how many days in advance, of today's date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don't use either of these options, the itinerary will default to today's date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave `startDate` and `endDate` empty.

Returns:

numberOfStayDays

setNumberOfStayDays

public void setNumberOfStayDays(Integer numberOfStayDays)

startDate

public EngineConfigurationBookingReportAgent startDate(LocalDate startDate)

getStartDate

@Nullable
@Valid
public @Valid LocalDate getStartDate()

Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave `numberOfAdvanceDays` and `numberOfStayDays` empty.

Returns:

startDate

setStartDate

public void setStartDate(LocalDate startDate)

endDate

public EngineConfigurationBookingReportAgent endDate(LocalDate endDate)

getEndDate

@Nullable
@Valid
public @Valid LocalDate getEndDate()

Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave `numberOfAdvanceDays` and `numberOfStayDays` empty.

Returns:

endDate

setEndDate

public void setEndDate(LocalDate endDate)

roomConfigurations

public EngineConfigurationBookingReportAgent roomConfigurations(List<RoomConfigurationAgent> roomConfigurations)

addRoomConfigurationsItem

public EngineConfigurationBookingReportAgent addRoomConfigurationsItem(RoomConfigurationAgent roomConfigurationsItem)

getRoomConfigurations

@Nullable
@Valid
public @Valid List<RoomConfigurationAgent> getRoomConfigurations()

Control how many adults / children will be staying and how many rooms. Defaults to: One room, two adults.

Returns:

roomConfigurations

setRoomConfigurations

public void setRoomConfigurations(List<RoomConfigurationAgent> roomConfigurations)

useDays

public EngineConfigurationBookingReportAgent useDays(Boolean useDays)

getUseDays

@Nullable
public Boolean getUseDays()

if true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate

Returns:

useDays

setUseDays

public void setUseDays(Boolean useDays)

promotionalCodes

public EngineConfigurationBookingReportAgent promotionalCodes(List<String> promotionalCodes)

addPromotionalCodesItem

public EngineConfigurationBookingReportAgent addPromotionalCodesItem(String promotionalCodesItem)

getPromotionalCodes

@Nullable
public List<String> getPromotionalCodes()

If you've received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.

Returns:

promotionalCodes

setPromotionalCodes

public void setPromotionalCodes(List<String> promotionalCodes)

sendBookingNotificationEmailsToProperty

public EngineConfigurationBookingReportAgent sendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty)

getSendBookingNotificationEmailsToProperty

@Nullable
public Boolean getSendBookingNotificationEmailsToProperty()

An integrator can choose to disable outgoing emails to properties because they want to do that themselves.

Returns:

sendBookingNotificationEmailsToProperty

setSendBookingNotificationEmailsToProperty

public void setSendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty)

sendBookingNotificationEmailsToBooker

public EngineConfigurationBookingReportAgent sendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker)

getSendBookingNotificationEmailsToBooker

@Nullable
public Boolean getSendBookingNotificationEmailsToBooker()

An integrator can choose to disable outgoing emails to users because they want to do that themselves.

Returns:

sendBookingNotificationEmailsToBooker

setSendBookingNotificationEmailsToBooker

public void setSendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker)

sendBookingNotificationEmailsToChannelManager

public EngineConfigurationBookingReportAgent sendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager)

getSendBookingNotificationEmailsToChannelManager

@Nullable
public Boolean getSendBookingNotificationEmailsToChannelManager()

An integrator can choose to disable notifying the property's channel manager. Note: This should ONLY be done for testing.

Returns:

sendBookingNotificationEmailsToChannelManager

setSendBookingNotificationEmailsToChannelManager

public void setSendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager)

wcBookClickAction

public EngineConfigurationBookingReportAgent wcBookClickAction(EngineConfigurationBookingReportAgent.WcBookClickActionEnum wcBookClickAction)

getWcBookClickAction

@Nullable
public EngineConfigurationBookingReportAgent.WcBookClickActionEnum getWcBookClickAction()

Action to complete once a user clicks on the CTA button on blocking.

Returns:

wcBookClickAction

setWcBookClickAction

public void setWcBookClickAction(EngineConfigurationBookingReportAgent.WcBookClickActionEnum wcBookClickAction)

city

public EngineConfigurationBookingReportAgent city(GeoNameAgent city)

getCity

@Nullable
@Valid
public @Valid GeoNameAgent getCity()

Get city

Returns:

city

setCity

public void setCity(GeoNameAgent city)

showUnavailableCard

public EngineConfigurationBookingReportAgent showUnavailableCard(Boolean showUnavailableCard)

getShowUnavailableCard

@Nullable
public Boolean getShowUnavailableCard()

Show unavailable blocking card when blocking not currently for sale. Otherwise, it displays a normal card but without the price.

Returns:

showUnavailableCard

setShowUnavailableCard

public void setShowUnavailableCard(Boolean showUnavailableCard)

showRankings

public EngineConfigurationBookingReportAgent showRankings(Boolean showRankings)

getShowRankings

@Nullable
public Boolean getShowRankings()

Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.

Returns:

showRankings

setShowRankings

public void setShowRankings(Boolean showRankings)

showSearch

public EngineConfigurationBookingReportAgent showSearch(Boolean showSearch)

getShowSearch

@Nullable
public Boolean getShowSearch()

This feature flag controls whether to let a user move away from the hotel landing page using search.

Returns:

showSearch

setShowSearch

public void setShowSearch(Boolean showSearch)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object