Package travel.wink.sdk.affiliate.model
Class EngineConfigurationAffiliate
java.lang.Object
travel.wink.sdk.affiliate.model.EngineConfigurationAffiliate
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-10-16T10:17:15.847873815+07:00[Asia/Bangkok]")
public class EngineConfigurationAffiliate
extends Object
EngineConfigurationAffiliate
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumSales channel sub-type.static enumAction to complete once a user clicks on the CTA button on inventory. -
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 String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddLogosItem(SimpleMultimediaAffiliate logosItem) addPromotionalCodesItem(String promotionalCodesItem) addRoomConfigurationsItem(RoomConfigurationAffiliate roomConfigurationsItem) appendToPageTitle(String appendToPageTitle) city(GeoNameAffiliate city) defaultCurrency(String defaultCurrency) defaultLanguage(String defaultLanguage) booleanWhether to append text to the existing booking engine page title.@Valid GeoNameAffiliategetCity()Get cityControl which currency your users see prices in initially.Control which language your users see text in initially.@Valid LocalDateSet a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date.If you want to track analytics with Google Analytics and GTM for your self-hosted booking engine, you need to import our [GTM profile](https://www.dropbox.com/s/o6rwluclvsgydma/gtm-template-2020-2.json?dl=0) into your GTM container and link it with your Google Analytics account.If you want your users to see Google Maps in your hosted booking engine, go to [Google Maps](https://console.developers.google.com/projectselector2/apis/credentials?supportedpurview=project) and create an API key for your site.If you are self-hosting our booking engine, let us know where it is hosted.@NotNull @Valid UUIDUnique engine configuration identifier@Valid List<SimpleMultimediaAffiliate>getLogos()Customize booking confirmation emails by adding a custom logo to your configuration.@NotNull StringgetName()Engine configuration nameYou can control the initial itinerary date used to retrieve travel inventory prices.You can control the initial itinerary date used to retrieve travel inventory prices.@NotNull @Valid UUIDEngine configuration record creator identifier@NotNull StringName of company owner.Indicates whether this configuration is primary.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<RoomConfigurationAffiliate>Control how many adults / children will be staying and how many rooms.Flag to indicate you are self-hosting our booking engine and not using our default booking engine url.An integrator can choose to disable outgoing emails to users because they want to do that themselves.An integrator can choose to disable notifying the property's channel manager.An integrator can choose to disable outgoing emails to properties because they want to do that themselves.Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.Show unavailable inventory card when inventory not currently for sale.@Valid LocalDateSet a fixed itinerary start date.Sales channel sub-type.If you want your users to be able to chat with you on your hosted booking engine, set yourself up with a [tawk.to account](https://dashboard.tawk.to/signup) and add your API key here.Get themeColorsif true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDateAction to complete once a user clicks on the CTA button on inventory.googleAnalyticsMeasurementId(String googleAnalyticsMeasurementId) googleMapsAPIKey(String googleMapsAPIKey) inthashCode()hostedBookingEngineUrl(String hostedBookingEngineUrl) identifier(UUID identifier) logos(List<SimpleMultimediaAffiliate> logos) numberOfAdvanceDays(Integer numberOfAdvanceDays) numberOfStayDays(Integer numberOfStayDays) ownerIdentifier(UUID ownerIdentifier) promotionalCodes(List<String> promotionalCodes) roomConfigurations(List<RoomConfigurationAffiliate> roomConfigurations) selfHosted(Boolean selfHosted) sendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker) sendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager) sendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty) voidsetAppendToPageTitle(String appendToPageTitle) voidsetCity(GeoNameAffiliate city) voidsetDefaultCurrency(String defaultCurrency) voidsetDefaultLanguage(String defaultLanguage) voidsetEndDate(LocalDate endDate) voidsetGoogleAnalyticsMeasurementId(String googleAnalyticsMeasurementId) voidsetGoogleMapsAPIKey(String googleMapsAPIKey) voidsetHostedBookingEngineUrl(String hostedBookingEngineUrl) voidsetIdentifier(UUID identifier) voidsetLogos(List<SimpleMultimediaAffiliate> logos) voidvoidsetNumberOfAdvanceDays(Integer numberOfAdvanceDays) voidsetNumberOfStayDays(Integer numberOfStayDays) voidsetOwnerIdentifier(UUID ownerIdentifier) voidsetOwnerName(String ownerName) voidsetPrimary(Boolean primary) voidsetPromotionalCodes(List<String> promotionalCodes) voidsetRoomConfigurations(List<RoomConfigurationAffiliate> roomConfigurations) voidsetSelfHosted(Boolean selfHosted) voidsetSendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker) voidsetSendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager) voidsetSendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty) voidsetShowRankings(Boolean showRankings) voidsetShowUnavailableCard(Boolean showUnavailableCard) voidsetStartDate(LocalDate startDate) voidvoidsetTawkToKey(String tawkToKey) voidsetThemeColors(EngineConfigurationThemeAffiliate themeColors) voidsetUseDays(Boolean useDays) voidsetWcBookClickAction(EngineConfigurationAffiliate.WcBookClickActionEnum wcBookClickAction) showRankings(Boolean showRankings) showUnavailableCard(Boolean showUnavailableCard) themeColors(EngineConfigurationThemeAffiliate themeColors) toString()wcBookClickAction(EngineConfigurationAffiliate.WcBookClickActionEnum wcBookClickAction)
-
Field Details
-
JSON_PROPERTY_IDENTIFIER
- See Also:
-
JSON_PROPERTY_NAME
- See Also:
-
JSON_PROPERTY_APPEND_TO_PAGE_TITLE
- See Also:
-
JSON_PROPERTY_OWNER_IDENTIFIER
- See Also:
-
JSON_PROPERTY_OWNER_NAME
- See Also:
-
JSON_PROPERTY_SUB_TYPE
- See Also:
-
JSON_PROPERTY_PRIMARY
- See Also:
-
JSON_PROPERTY_GOOGLE_ANALYTICS_MEASUREMENT_ID
- See Also:
-
JSON_PROPERTY_GOOGLE_MAPS_A_P_I_KEY
- See Also:
-
JSON_PROPERTY_TAWK_TO_KEY
- See Also:
-
JSON_PROPERTY_DEFAULT_CURRENCY
- See Also:
-
JSON_PROPERTY_DEFAULT_LANGUAGE
- See Also:
-
JSON_PROPERTY_LOGOS
- See Also:
-
JSON_PROPERTY_HOSTED_BOOKING_ENGINE_URL
- See Also:
-
JSON_PROPERTY_SELF_HOSTED
- See Also:
-
JSON_PROPERTY_THEME_COLORS
- See Also:
-
JSON_PROPERTY_NUMBER_OF_ADVANCE_DAYS
- See Also:
-
JSON_PROPERTY_NUMBER_OF_STAY_DAYS
- See Also:
-
JSON_PROPERTY_START_DATE
- See Also:
-
JSON_PROPERTY_END_DATE
- See Also:
-
JSON_PROPERTY_ROOM_CONFIGURATIONS
- See Also:
-
JSON_PROPERTY_USE_DAYS
- See Also:
-
JSON_PROPERTY_PROMOTIONAL_CODES
- See Also:
-
JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_PROPERTY
- See Also:
-
JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_BOOKER
- See Also:
-
JSON_PROPERTY_SEND_BOOKING_NOTIFICATION_EMAILS_TO_CHANNEL_MANAGER
- See Also:
-
JSON_PROPERTY_WC_BOOK_CLICK_ACTION
- See Also:
-
JSON_PROPERTY_CITY
- See Also:
-
JSON_PROPERTY_SHOW_UNAVAILABLE_CARD
- See Also:
-
JSON_PROPERTY_SHOW_RANKINGS
- See Also:
-
-
Constructor Details
-
EngineConfigurationAffiliate
public EngineConfigurationAffiliate()
-
-
Method Details
-
identifier
-
getIdentifier
Unique engine configuration identifier- Returns:
- identifier
-
setIdentifier
-
name
-
getName
Engine configuration name- Returns:
- name
-
setName
-
appendToPageTitle
-
getAppendToPageTitle
Whether to append text to the existing booking engine page title.- Returns:
- appendToPageTitle
-
setAppendToPageTitle
-
ownerIdentifier
-
getOwnerIdentifier
Engine configuration record creator identifier- Returns:
- ownerIdentifier
-
setOwnerIdentifier
-
ownerName
-
getOwnerName
Name of company owner.- Returns:
- ownerName
-
setOwnerName
-
subType
-
getSubType
Sales channel sub-type.- Returns:
- subType
-
setSubType
-
-
getPrimary
Indicates whether this configuration is primary. A primary configuration cannot be removed.- Returns:
- primary
-
setPrimary
-
googleAnalyticsMeasurementId
public EngineConfigurationAffiliate googleAnalyticsMeasurementId(String googleAnalyticsMeasurementId) -
getGoogleAnalyticsMeasurementId
If you want to track analytics with Google Analytics and GTM for your self-hosted booking engine, you need to import our [GTM profile](https://www.dropbox.com/s/o6rwluclvsgydma/gtm-template-2020-2.json?dl=0) into your GTM container and link it with your Google Analytics account. [More about that here](https://bearchoke.atlassian.net/wiki/spaces/TC/pages/2941648897/Linking+your+Google+Tag+Manager+account)- Returns:
- googleAnalyticsMeasurementId
-
setGoogleAnalyticsMeasurementId
-
googleMapsAPIKey
-
getGoogleMapsAPIKey
If you want your users to see Google Maps in your hosted booking engine, go to [Google Maps](https://console.developers.google.com/projectselector2/apis/credentials?supportedpurview=project) and create an API key for your site.- Returns:
- googleMapsAPIKey
-
setGoogleMapsAPIKey
-
tawkToKey
-
getTawkToKey
If you want your users to be able to chat with you on your hosted booking engine, set yourself up with a [tawk.to account](https://dashboard.tawk.to/signup) and add your API key here.- Returns:
- tawkToKey
-
setTawkToKey
-
defaultCurrency
-
getDefaultCurrency
Control which currency your users see prices in initially.- Returns:
- defaultCurrency
-
setDefaultCurrency
-
defaultLanguage
-
getDefaultLanguage
Control which language your users see text in initially.- Returns:
- defaultLanguage
-
setDefaultLanguage
-
logos
-
addLogosItem
-
getLogos
Customize booking confirmation emails by adding a custom logo to your configuration.- Returns:
- logos
-
setLogos
-
hostedBookingEngineUrl
-
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
-
selfHosted
-
getSelfHosted
Flag to indicate you are self-hosting our booking engine and not using our default booking engine url.- Returns:
- selfHosted
-
setSelfHosted
-
themeColors
-
getThemeColors
Get themeColors- Returns:
- themeColors
-
setThemeColors
-
numberOfAdvanceDays
-
getNumberOfAdvanceDays
You can control the initial itinerary date used to retrieve travel inventory 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
-
numberOfStayDays
-
getNumberOfStayDays
You can control the initial itinerary date used to retrieve travel inventory 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
-
startDate
-
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
-
endDate
-
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
-
roomConfigurations
public EngineConfigurationAffiliate roomConfigurations(List<RoomConfigurationAffiliate> roomConfigurations) -
addRoomConfigurationsItem
public EngineConfigurationAffiliate addRoomConfigurationsItem(RoomConfigurationAffiliate roomConfigurationsItem) -
getRoomConfigurations
Control how many adults / children will be staying and how many rooms. Defaults to: One room, two adults.- Returns:
- roomConfigurations
-
setRoomConfigurations
-
useDays
-
getUseDays
if true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate- Returns:
- useDays
-
setUseDays
-
promotionalCodes
-
addPromotionalCodesItem
-
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
-
sendBookingNotificationEmailsToProperty
public EngineConfigurationAffiliate sendBookingNotificationEmailsToProperty(Boolean sendBookingNotificationEmailsToProperty) -
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 EngineConfigurationAffiliate sendBookingNotificationEmailsToBooker(Boolean sendBookingNotificationEmailsToBooker) -
getSendBookingNotificationEmailsToBooker
An integrator can choose to disable outgoing emails to users because they want to do that themselves.- Returns:
- sendBookingNotificationEmailsToBooker
-
setSendBookingNotificationEmailsToBooker
-
sendBookingNotificationEmailsToChannelManager
public EngineConfigurationAffiliate sendBookingNotificationEmailsToChannelManager(Boolean sendBookingNotificationEmailsToChannelManager) -
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 EngineConfigurationAffiliate wcBookClickAction(EngineConfigurationAffiliate.WcBookClickActionEnum wcBookClickAction) -
getWcBookClickAction
Action to complete once a user clicks on the CTA button on inventory.- Returns:
- wcBookClickAction
-
setWcBookClickAction
public void setWcBookClickAction(EngineConfigurationAffiliate.WcBookClickActionEnum wcBookClickAction) -
city
-
getCity
Get city- Returns:
- city
-
setCity
-
showRankings
-
getShowRankings
Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.- Returns:
- showRankings
-
setShowRankings
-
equals
-
hashCode
public int hashCode() -
toString
-