Class EngineConfiguration

java.lang.Object
travel.wink.sdk.affiliate.model.EngineConfiguration

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-07-21T13:34:06.734669+07:00[Asia/Bangkok]") public class EngineConfiguration extends Object
EngineConfiguration
  • Field Details

  • Constructor Details

    • EngineConfiguration

      public EngineConfiguration()
  • Method Details

    • identifier

      public EngineConfiguration identifier(UUID identifier)
    • getIdentifier

      @Nullable @Valid public @Valid UUID getIdentifier()
      Unique engine configuration identifier
      Returns:
      identifier
    • setIdentifier

      public void setIdentifier(UUID identifier)
    • name

      public EngineConfiguration name(String name)
    • getName

      @Nonnull @NotNull public @NotNull String getName()
      Engine configuration name
      Returns:
      name
    • setName

      public void setName(String name)
    • appendToPageTitle

      public EngineConfiguration appendToPageTitle(String appendToPageTitle)
    • getAppendToPageTitle

      @Nullable public String getAppendToPageTitle()
      Whether to append text to the existing booking engine page title.
      Returns:
      appendToPageTitle
    • setAppendToPageTitle

      public void setAppendToPageTitle(String appendToPageTitle)
    • ownerIdentifier

      public EngineConfiguration ownerIdentifier(UUID ownerIdentifier)
    • getOwnerIdentifier

      @Nullable @Valid public @Valid UUID getOwnerIdentifier()
      Engine configuration record creator identifier
      Returns:
      ownerIdentifier
    • setOwnerIdentifier

      public void setOwnerIdentifier(UUID ownerIdentifier)
    • ownerName

      public EngineConfiguration ownerName(String ownerName)
    • getOwnerName

      @Nullable public String getOwnerName()
      Name of company owner.
      Returns:
      ownerName
    • setOwnerName

      public void setOwnerName(String ownerName)
    • subType

    • getSubType

      @Nullable public EngineConfiguration.SubTypeEnum getSubType()
      Sales channel sub-type.
      Returns:
      subType
    • setSubType

      public void setSubType(EngineConfiguration.SubTypeEnum subType)
    • primary

      public EngineConfiguration primary(Boolean primary)
    • getPrimary

      @Nullable public Boolean getPrimary()
      Indicates whether this configuration is primary. A primary configuration cannot be removed.
      Returns:
      primary
    • setPrimary

      public void setPrimary(Boolean primary)
    • googleTagManagerKey

      public EngineConfiguration googleTagManagerKey(String googleTagManagerKey)
    • getGoogleTagManagerKey

      @Nullable public String getGoogleTagManagerKey()
      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:
      googleTagManagerKey
    • setGoogleTagManagerKey

      public void setGoogleTagManagerKey(String googleTagManagerKey)
    • wcGoogleTagManagerKey

      public EngineConfiguration wcGoogleTagManagerKey(String wcGoogleTagManagerKey)
    • getWcGoogleTagManagerKey

      @Nullable public String getWcGoogleTagManagerKey()
      If you want to track analytics with Google Analytics and GTM for the Web Components you've embedded, 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:
      wcGoogleTagManagerKey
    • setWcGoogleTagManagerKey

      public void setWcGoogleTagManagerKey(String wcGoogleTagManagerKey)
    • googleMapsAPIKey

      public EngineConfiguration googleMapsAPIKey(String googleMapsAPIKey)
    • getGoogleMapsAPIKey

      @Nullable public String 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

      public void setGoogleMapsAPIKey(String googleMapsAPIKey)
    • wcGoogleMapsAPIKey

      public EngineConfiguration wcGoogleMapsAPIKey(String wcGoogleMapsAPIKey)
    • getWcGoogleMapsAPIKey

      @Nullable public String getWcGoogleMapsAPIKey()
      If you want your users to see Google Maps in any of our Web Components, go to [Google Maps](https://console.developers.google.com/projectselector2/apis/credentials?supportedpurview=project) and create an API key for your site.
      Returns:
      wcGoogleMapsAPIKey
    • setWcGoogleMapsAPIKey

      public void setWcGoogleMapsAPIKey(String wcGoogleMapsAPIKey)
    • tawkToKey

      public EngineConfiguration tawkToKey(String tawkToKey)
    • getTawkToKey

      @Nullable public String 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

      public void setTawkToKey(String tawkToKey)
    • wcTawkToKey

      public EngineConfiguration wcTawkToKey(String wcTawkToKey)
    • getWcTawkToKey

      @Nullable public String getWcTawkToKey()
      If you want your users to be able to chat with in any of our Web Components, set yourself up with a [tawk.to account](https://dashboard.tawk.to/signup) and add your API key here.
      Returns:
      wcTawkToKey
    • setWcTawkToKey

      public void setWcTawkToKey(String wcTawkToKey)
    • defaultCurrency

      public EngineConfiguration 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 EngineConfiguration 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)
    • logos

      public EngineConfiguration logos(List<Multimedia> logos)
    • addLogosItem

      public EngineConfiguration addLogosItem(Multimedia logosItem)
    • getLogos

      @Nullable @Valid public @Valid List<Multimedia> getLogos()
      Customize booking confirmation emails by adding a custom logo to your configuration.
      Returns:
      logos
    • setLogos

      public void setLogos(List<Multimedia> logos)
    • hostedBookingEngineUrl

      public EngineConfiguration 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 EngineConfiguration 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 EngineConfiguration themeColors(EngineConfigurationTheme themeColors)
    • getThemeColors

      @Nullable @Valid public @Valid EngineConfigurationTheme getThemeColors()
      Get themeColors
      Returns:
      themeColors
    • setThemeColors

      public void setThemeColors(EngineConfigurationTheme themeColors)
    • numberOfAdvanceDays

      public EngineConfiguration numberOfAdvanceDays(Integer numberOfAdvanceDays)
    • getNumberOfAdvanceDays

      @Nullable public Integer 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

      public void setNumberOfAdvanceDays(Integer numberOfAdvanceDays)
    • numberOfStayDays

      public EngineConfiguration numberOfStayDays(Integer numberOfStayDays)
    • getNumberOfStayDays

      @Nullable public Integer 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

      public void setNumberOfStayDays(Integer numberOfStayDays)
    • startDate

      public EngineConfiguration 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 EngineConfiguration 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 EngineConfiguration roomConfigurations(List<RoomConfiguration> roomConfigurations)
    • addRoomConfigurationsItem

      public EngineConfiguration addRoomConfigurationsItem(RoomConfiguration roomConfigurationsItem)
    • getRoomConfigurations

      @Nullable @Valid public @Valid List<RoomConfiguration> 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<RoomConfiguration> roomConfigurations)
    • useDays

      public EngineConfiguration 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 EngineConfiguration promotionalCodes(List<String> promotionalCodes)
    • addPromotionalCodesItem

      public EngineConfiguration 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 EngineConfiguration 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 EngineConfiguration 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)
    • wcBookClickAction

      public EngineConfiguration wcBookClickAction(EngineConfiguration.WcBookClickActionEnum wcBookClickAction)
    • getWcBookClickAction

      @Nullable public EngineConfiguration.WcBookClickActionEnum getWcBookClickAction()
      Action to complete once a user clicks on the CTA button on inventory.
      Returns:
      wcBookClickAction
    • setWcBookClickAction

      public void setWcBookClickAction(EngineConfiguration.WcBookClickActionEnum wcBookClickAction)
    • 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