Class BookingAgent

java.lang.Object
travel.wink.sdk.travel.agent.model.BookingAgent
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-01-02T16:46:07.843023788+07:00[Asia/Bangkok]") public class BookingAgent extends Object
Booking data object

  • Field Details

  • Constructor Details

    • BookingAgent

      public BookingAgent()

  • Method Details

    • creation

      public BookingAgent creation(BookingAgent.CreationEnum creation)

    • getCreation

      @Nullable public BookingAgent.CreationEnum getCreation()
      Communicates whether the booking was created normally or if it failed or was just for testing.
      Returns:
      creation

    • setCreation

      public void setCreation(BookingAgent.CreationEnum creation)

    • date

      public BookingAgent date(LocalDateTime date)

    • getDate

      @Nonnull @NotNull @Valid public LocalDateTime getDate()
      Date and time the booking was made.
      Returns:
      date

    • setDate

      public void setDate(LocalDateTime date)

    • groupIdentifier

      public BookingAgent groupIdentifier(UUID groupIdentifier)

    • getGroupIdentifier

      @Nonnull @NotNull @Valid public @NotNull @Valid UUID getGroupIdentifier()
      Unique record identifier for the collection of bookings that were made at the same time.
      Returns:
      groupIdentifier

    • setGroupIdentifier

      public void setGroupIdentifier(UUID groupIdentifier)

    • identifier

      public BookingAgent identifier(UUID identifier)

    • getIdentifier

      @Nonnull @NotNull @Valid public @NotNull @Valid UUID getIdentifier()
      Unique record identifier
      Returns:
      identifier

    • setIdentifier

      public void setIdentifier(UUID identifier)

    • engineConfiguration

      public BookingAgent engineConfiguration(EngineConfigurationBookingReportAgent engineConfiguration)

    • getEngineConfiguration

      @Nonnull @NotNull @Valid public @NotNull @Valid EngineConfigurationBookingReportAgent getEngineConfiguration()
      Get engineConfiguration
      Returns:
      engineConfiguration

    • setEngineConfiguration

      public void setEngineConfiguration(EngineConfigurationBookingReportAgent engineConfiguration)

    • bookingCode

      public BookingAgent bookingCode(String bookingCode)

    • getBookingCode

      @Nonnull @NotNull public @NotNull String getBookingCode()
      Unique user-friendly booking geoname. This code should be used when corresponding with travelers.
      Returns:
      bookingCode

    • setBookingCode

      public void setBookingCode(String bookingCode)

    • user

      public BookingAgent user(BookingUserAgent user)

    • getUser

      @Nonnull @NotNull @Valid public @NotNull @Valid BookingUserAgent getUser()
      Get user
      Returns:
      user

    • setUser

      public void setUser(BookingUserAgent user)

    • userSession

      public BookingAgent userSession(BookingUserSessionAgent userSession)

    • getUserSession

      @Nonnull @NotNull @Valid public @NotNull @Valid BookingUserSessionAgent getUserSession()
      Get userSession
      Returns:
      userSession

    • setUserSession

      public void setUserSession(BookingUserSessionAgent userSession)

    • serverUrl

      public BookingAgent serverUrl(String serverUrl)

    • getServerUrl

      @Nonnull @NotNull public @NotNull String getServerUrl()
      The URL the booking occurred
      Returns:
      serverUrl

    • setServerUrl

      public void setServerUrl(String serverUrl)

    • contactInfo

      public BookingAgent contactInfo(ContactAgent contactInfo)

    • getContactInfo

      @Nonnull @NotNull @Valid public @NotNull @Valid ContactAgent getContactInfo()
      Get contactInfo
      Returns:
      contactInfo

    • setContactInfo

      public void setContactInfo(ContactAgent contactInfo)

    • address

      public BookingAgent address(AddressAgent address)

    • getAddress

      @Nonnull @NotNull @Valid public @NotNull @Valid AddressAgent getAddress()
      Get address
      Returns:
      address

    • setAddress

      public void setAddress(AddressAgent address)

    • socials

      public BookingAgent socials(List<SocialAgent> socials)

    • addSocialsItem

      public BookingAgent addSocialsItem(SocialAgent socialsItem)

    • getSocials

      @Nullable @Valid public @Valid List<SocialAgent> getSocials()
      List of all social network account property has for the traveler to get in touch.
      Returns:
      socials

    • setSocials

      public void setSocials(List<SocialAgent> socials)

    • review

      public BookingAgent review(ReviewAgent review)

    • getReview

      @Nullable @Valid public @Valid ReviewAgent getReview()
      Get review
      Returns:
      review

    • setReview

      public void setReview(ReviewAgent review)

    • emailHeaderLogoUrl

      public BookingAgent emailHeaderLogoUrl(String emailHeaderLogoUrl)

    • getEmailHeaderLogoUrl

      @Nonnull @NotNull public @NotNull String getEmailHeaderLogoUrl()
      Full url of the image logo optimized for emails
      Returns:
      emailHeaderLogoUrl

    • setEmailHeaderLogoUrl

      public void setEmailHeaderLogoUrl(String emailHeaderLogoUrl)

    • logoIdentifier

      public BookingAgent logoIdentifier(String logoIdentifier)

    • getLogoIdentifier

      @Nullable public String getLogoIdentifier()
      Logo cloudinary identifier for potential reuse
      Returns:
      logoIdentifier

    • setLogoIdentifier

      public void setLogoIdentifier(String logoIdentifier)

    • hotel

      public BookingAgent hotel(HotelOnMapAgent hotel)

    • getHotel

      @Nonnull @NotNull @Valid public @NotNull @Valid HotelOnMapAgent getHotel()
      Get hotel
      Returns:
      hotel

    • setHotel

      public void setHotel(HotelOnMapAgent hotel)

    • roomStay

      public BookingAgent roomStay(RoomStayAgent roomStay)

    • getRoomStay

      @Nullable @Valid public @Valid RoomStayAgent getRoomStay()
      Get roomStay
      Returns:
      roomStay

    • setRoomStay

      public void setRoomStay(RoomStayAgent roomStay)

    • specialRequests

      public BookingAgent specialRequests(String specialRequests)

    • getSpecialRequests

      @Nullable public String getSpecialRequests()
      Free text where the traveler can add a message to the property.
      Returns:
      specialRequests

    • setSpecialRequests

      public void setSpecialRequests(String specialRequests)

    • comment

      public BookingAgent comment(String comment)

    • getComment

      @Nullable public String getComment()
      Internal comment field the platform can add and make available to channel manager partners.
      Returns:
      comment

    • setComment

      public void setComment(String comment)

    • earlyCheckInCharge

      public BookingAgent earlyCheckInCharge(CustomMonetaryAmount earlyCheckInCharge)

    • getEarlyCheckInCharge

      @Nullable @Valid public @Valid CustomMonetaryAmount getEarlyCheckInCharge()
      Get earlyCheckInCharge
      Returns:
      earlyCheckInCharge

    • setEarlyCheckInCharge

      public void setEarlyCheckInCharge(CustomMonetaryAmount earlyCheckInCharge)

    • lateCheckOutCharge

      public BookingAgent lateCheckOutCharge(CustomMonetaryAmount lateCheckOutCharge)

    • getLateCheckOutCharge

      @Nullable @Valid public @Valid CustomMonetaryAmount getLateCheckOutCharge()
      Get lateCheckOutCharge
      Returns:
      lateCheckOutCharge

    • setLateCheckOutCharge

      public void setLateCheckOutCharge(CustomMonetaryAmount lateCheckOutCharge)

    • earlyCheckInChargePercent

      public BookingAgent earlyCheckInChargePercent(Float earlyCheckInChargePercent)

    • getEarlyCheckInChargePercent

      @Nullable public Float getEarlyCheckInChargePercent()
      Early check-in charge calculated in percent of first room night price.
      Returns:
      earlyCheckInChargePercent

    • setEarlyCheckInChargePercent

      public void setEarlyCheckInChargePercent(Float earlyCheckInChargePercent)

    • lateCheckOutChargePercent

      public BookingAgent lateCheckOutChargePercent(Float lateCheckOutChargePercent)

    • getLateCheckOutChargePercent

      @Nullable public Float getLateCheckOutChargePercent()
      Early check-in charge calculated in percent of first room night price.
      Returns:
      lateCheckOutChargePercent

    • setLateCheckOutChargePercent

      public void setLateCheckOutChargePercent(Float lateCheckOutChargePercent)

    • hotelImageUrl

      public BookingAgent hotelImageUrl(String hotelImageUrl)

    • getHotelImageUrl

      @Nonnull @NotNull public @NotNull String getHotelImageUrl()
      Absolute URL of hotel image that can be used as-is
      Returns:
      hotelImageUrl

    • setHotelImageUrl

      public void setHotelImageUrl(String hotelImageUrl)

    • roomImageUrl

      public BookingAgent roomImageUrl(String roomImageUrl)

    • getRoomImageUrl

      @Nonnull @NotNull public @NotNull String getRoomImageUrl()
      Absolute URL of room image that can be used as-is
      Returns:
      roomImageUrl

    • setRoomImageUrl

      public void setRoomImageUrl(String roomImageUrl)

    • commissionList

      public BookingAgent commissionList(List<CommissionableEntryAgent> commissionList)

    • addCommissionListItem

      public BookingAgent addCommissionListItem(CommissionableEntryAgent commissionListItem)

    • getCommissionList

      @Nullable @Valid public @Valid List<CommissionableEntryAgent> getCommissionList()
      List of all travel inventory entries that are due a commission to the affiliate.
      Returns:
      commissionList

    • setCommissionList

      public void setCommissionList(List<CommissionableEntryAgent> commissionList)

    • ancillaryList

      public BookingAgent ancillaryList(List<BookingAncillaryAgent> ancillaryList)

    • addAncillaryListItem

      public BookingAgent addAncillaryListItem(BookingAncillaryAgent ancillaryListItem)

    • getAncillaryList

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getAncillaryList()
      Get ancillaryList
      Returns:
      ancillaryList

    • setAncillaryList

      public void setAncillaryList(List<BookingAncillaryAgent> ancillaryList)

    • bookingContract

      public BookingAgent bookingContract(BookingContractAgent bookingContract)

    • getBookingContract

      @Nullable @Valid public @Valid BookingContractAgent getBookingContract()
      Get bookingContract
      Returns:
      bookingContract

    • setBookingContract

      public void setBookingContract(BookingContractAgent bookingContract)

    • staticMapImageUrl

      public BookingAgent staticMapImageUrl(String staticMapImageUrl)

    • getStaticMapImageUrl

      @Nullable public String getStaticMapImageUrl()
      Url of map image that can be sent via email
      Returns:
      staticMapImageUrl

    • setStaticMapImageUrl

      public void setStaticMapImageUrl(String staticMapImageUrl)

    • staticMapUrl

      public BookingAgent staticMapUrl(String staticMapUrl)

    • getStaticMapUrl

      @Nullable public String getStaticMapUrl()
      Url of map image location on Google Maps
      Returns:
      staticMapUrl

    • setStaticMapUrl

      public void setStaticMapUrl(String staticMapUrl)

    • status

      public BookingAgent status(BookingAgent.StatusEnum status)

    • getStatus

      @Nullable public BookingAgent.StatusEnum getStatus()
      Convenience data point to show which status the booking currently has.
      Returns:
      status

    • setStatus

      public void setStatus(BookingAgent.StatusEnum status)

    • meetingRooms

      public BookingAgent meetingRooms(List<BookingAncillaryAgent> meetingRooms)

    • addMeetingRoomsItem

      public BookingAgent addMeetingRoomsItem(BookingAncillaryAgent meetingRoomsItem)

    • getMeetingRooms

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getMeetingRooms()
      Meeting room reservation records.
      Returns:
      meetingRooms

    • setMeetingRooms

      public void setMeetingRooms(List<BookingAncillaryAgent> meetingRooms)

    • restaurants

      public BookingAgent restaurants(List<BookingAncillaryAgent> restaurants)

    • addRestaurantsItem

      public BookingAgent addRestaurantsItem(BookingAncillaryAgent restaurantsItem)

    • getRestaurants

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getRestaurants()
      Restaurant reservation records.
      Returns:
      restaurants

    • setRestaurants

      public void setRestaurants(List<BookingAncillaryAgent> restaurants)

    • spas

      public BookingAgent spas(List<BookingAncillaryAgent> spas)

    • addSpasItem

      public BookingAgent addSpasItem(BookingAncillaryAgent spasItem)

    • getSpas

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getSpas()
      Spa reservation records.
      Returns:
      spas

    • setSpas

      public void setSpas(List<BookingAncillaryAgent> spas)

    • activities

      public BookingAgent activities(List<BookingAncillaryAgent> activities)

    • addActivitiesItem

      public BookingAgent addActivitiesItem(BookingAncillaryAgent activitiesItem)

    • getActivities

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getActivities()
      Activity reservation records.
      Returns:
      activities

    • setActivities

      public void setActivities(List<BookingAncillaryAgent> activities)

    • attractions

      public BookingAgent attractions(List<BookingAncillaryAgent> attractions)

    • addAttractionsItem

      public BookingAgent addAttractionsItem(BookingAncillaryAgent attractionsItem)

    • getAttractions

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getAttractions()
      Attraction reservation records.
      Returns:
      attractions

    • setAttractions

      public void setAttractions(List<BookingAncillaryAgent> attractions)

    • places

      public BookingAgent places(List<BookingAncillaryAgent> places)

    • addPlacesItem

      public BookingAgent addPlacesItem(BookingAncillaryAgent placesItem)

    • getPlaces

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getPlaces()
      Place reservation records.
      Returns:
      places

    • setPlaces

      public void setPlaces(List<BookingAncillaryAgent> places)

    • roomTypeAncillaries

      public BookingAgent roomTypeAncillaries(List<BookingAncillaryAgent> roomTypeAncillaries)

    • addRoomTypeAncillariesItem

      public BookingAgent addRoomTypeAncillariesItem(BookingAncillaryAgent roomTypeAncillariesItem)

    • getRoomTypeAncillaries

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getRoomTypeAncillaries()
      Room type ancillary records.
      Returns:
      roomTypeAncillaries

    • setRoomTypeAncillaries

      public void setRoomTypeAncillaries(List<BookingAncillaryAgent> roomTypeAncillaries)

    • addOns

      public BookingAgent addOns(List<BookingAncillaryAgent> addOns)

    • addAddOnsItem

      public BookingAgent addAddOnsItem(BookingAncillaryAgent addOnsItem)

    • getAddOns

      @Nullable @Valid public @Valid List<BookingAncillaryAgent> getAddOns()
      Add-on records.
      Returns:
      addOns

    • setAddOns

      public void setAddOns(List<BookingAncillaryAgent> addOns)

    • fullAddress

      public BookingAgent fullAddress(String fullAddress)

    • getFullAddress

      @Nullable public String getFullAddress()
      Convenience data point to return the full hotel address.
      Returns:
      fullAddress

    • setFullAddress

      public void setFullAddress(String fullAddress)

    • rateSource

      public BookingAgent rateSource(String rateSource)

    • getRateSource

      @Nullable public String getRateSource()
      Rate origin. This is usually the property channel manager.
      Returns:
      rateSource

    • setRateSource

      public void setRateSource(String rateSource)

    • cancellableByAgent

      public BookingAgent cancellableByAgent(Boolean cancellableByAgent)

    • getCancellableByAgent

      @Nullable public Boolean getCancellableByAgent()
      Whether the booking can still be cancelled completely by the agent.
      Returns:
      cancellableByAgent

    • setCancellableByAgent

      public void setCancellableByAgent(Boolean cancellableByAgent)

    • cancellableBySupplier

      public BookingAgent cancellableBySupplier(Boolean cancellableBySupplier)

    • getCancellableBySupplier

      @Nullable public Boolean getCancellableBySupplier()
      Whether the booking can still be cancelled completely by the supplier.
      Returns:
      cancellableBySupplier

    • setCancellableBySupplier

      public void setCancellableBySupplier(Boolean cancellableBySupplier)

    • cancellableByTraveler

      public BookingAgent cancellableByTraveler(Boolean cancellableByTraveler)

    • getCancellableByTraveler

      @Nullable public Boolean getCancellableByTraveler()
      Whether the booking can still be cancelled completely by the traveller.
      Returns:
      cancellableByTraveler

    • setCancellableByTraveler

      public void setCancellableByTraveler(Boolean cancellableByTraveler)

    • hasAddOns

      public BookingAgent hasAddOns(Boolean hasAddOns)

    • getHasAddOns

      @Nullable public Boolean getHasAddOns()
      Convenience data point to check if any add-on offers are in this booking.
      Returns:
      hasAddOns

    • setHasAddOns

      public void setHasAddOns(Boolean hasAddOns)

    • hasRoomTypeAncillaries

      public BookingAgent hasRoomTypeAncillaries(Boolean hasRoomTypeAncillaries)

    • getHasRoomTypeAncillaries

      @Nullable public Boolean getHasRoomTypeAncillaries()
      Convenience data point to check if any room type ancillaries are in this booking.
      Returns:
      hasRoomTypeAncillaries

    • setHasRoomTypeAncillaries

      public void setHasRoomTypeAncillaries(Boolean hasRoomTypeAncillaries)

    • hasFood

      public BookingAgent hasFood(Boolean hasFood)

    • getHasFood

      @Nullable public Boolean getHasFood()
      Convenience data point to check if any food is included in this booking.
      Returns:
      hasFood

    • setHasFood

      public void setHasFood(Boolean hasFood)

    • hasRestaurants

      public BookingAgent hasRestaurants(Boolean hasRestaurants)

    • getHasRestaurants

      @Nullable public Boolean getHasRestaurants()
      Convenience data point to check if any restaurant reservations are included in this booking.
      Returns:
      hasRestaurants

    • setHasRestaurants

      public void setHasRestaurants(Boolean hasRestaurants)

    • hasMeetingRooms

      public BookingAgent hasMeetingRooms(Boolean hasMeetingRooms)

    • getHasMeetingRooms

      @Nullable public Boolean getHasMeetingRooms()
      Convenience data point to check if any meeting room reservations are included in this booking.
      Returns:
      hasMeetingRooms

    • setHasMeetingRooms

      public void setHasMeetingRooms(Boolean hasMeetingRooms)

    • hasSpas

      public BookingAgent hasSpas(Boolean hasSpas)

    • getHasSpas

      @Nullable public Boolean getHasSpas()
      Convenience data point to check if any spa reservations are included in this booking.
      Returns:
      hasSpas

    • setHasSpas

      public void setHasSpas(Boolean hasSpas)

    • hasActivities

      public BookingAgent hasActivities(Boolean hasActivities)

    • getHasActivities

      @Nullable public Boolean getHasActivities()
      Convenience data point to check if any activity reservations are included in this booking.
      Returns:
      hasActivities

    • setHasActivities

      public void setHasActivities(Boolean hasActivities)

    • hasAttractions

      public BookingAgent hasAttractions(Boolean hasAttractions)

    • getHasAttractions

      @Nullable public Boolean getHasAttractions()
      Convenience data point to check if any attractions reservations are included in this booking.
      Returns:
      hasAttractions

    • setHasAttractions

      public void setHasAttractions(Boolean hasAttractions)

    • hasPlaces

      public BookingAgent hasPlaces(Boolean hasPlaces)

    • getHasPlaces

      @Nullable public Boolean getHasPlaces()
      Convenience data point to check if any place reservations are included in this booking.
      Returns:
      hasPlaces

    • setHasPlaces

      public void setHasPlaces(Boolean hasPlaces)

    • reportingDailyRateList

      public BookingAgent reportingDailyRateList(List<ReportingDailyRateAgent> reportingDailyRateList)

    • addReportingDailyRateListItem

      public BookingAgent addReportingDailyRateListItem(ReportingDailyRateAgent reportingDailyRateListItem)

    • getReportingDailyRateList

      @Nullable @Valid public @Valid List<ReportingDailyRateAgent> getReportingDailyRateList()
      Get reportingDailyRateList
      Returns:
      reportingDailyRateList

    • setReportingDailyRateList

      public void setReportingDailyRateList(List<ReportingDailyRateAgent> reportingDailyRateList)

    • reportingAncillaryList

      public BookingAgent reportingAncillaryList(List<ReportingAncillaryAgent> reportingAncillaryList)

    • addReportingAncillaryListItem

      public BookingAgent addReportingAncillaryListItem(ReportingAncillaryAgent reportingAncillaryListItem)

    • getReportingAncillaryList

      @Nullable @Valid public @Valid List<ReportingAncillaryAgent> getReportingAncillaryList()
      Get reportingAncillaryList
      Returns:
      reportingAncillaryList

    • setReportingAncillaryList

      public void setReportingAncillaryList(List<ReportingAncillaryAgent> reportingAncillaryList)

    • reportingExtraChargeList

      public BookingAgent reportingExtraChargeList(List<ReportingExtraChargeAgent> reportingExtraChargeList)

    • addReportingExtraChargeListItem

      public BookingAgent addReportingExtraChargeListItem(ReportingExtraChargeAgent reportingExtraChargeListItem)

    • getReportingExtraChargeList

      @Nullable @Valid public @Valid List<ReportingExtraChargeAgent> getReportingExtraChargeList()
      Get reportingExtraChargeList
      Returns:
      reportingExtraChargeList

    • setReportingExtraChargeList

      public void setReportingExtraChargeList(List<ReportingExtraChargeAgent> reportingExtraChargeList)

    • hasBreakfast

      public BookingAgent hasBreakfast(Boolean hasBreakfast)

    • getHasBreakfast

      @Nullable public Boolean getHasBreakfast()
      Convenience data point to get to breakfast quickly.
      Returns:
      hasBreakfast

    • setHasBreakfast

      public void setHasBreakfast(Boolean hasBreakfast)

    • hasBrunch

      public BookingAgent hasBrunch(Boolean hasBrunch)

    • getHasBrunch

      @Nullable public Boolean getHasBrunch()
      Convenience data point to get to brunch quickly.
      Returns:
      hasBrunch

    • setHasBrunch

      public void setHasBrunch(Boolean hasBrunch)

    • hasLunch

      public BookingAgent hasLunch(Boolean hasLunch)

    • getHasLunch

      @Nullable public Boolean getHasLunch()
      Convenience data point to get to lunch quickly.
      Returns:
      hasLunch

    • setHasLunch

      public void setHasLunch(Boolean hasLunch)

    • hasDinner

      public BookingAgent hasDinner(Boolean hasDinner)

    • getHasDinner

      @Nullable public Boolean getHasDinner()
      Convenience data point to get to dinner quickly.
      Returns:
      hasDinner

    • setHasDinner

      public void setHasDinner(Boolean hasDinner)

    • hasAllInclusive

      public BookingAgent hasAllInclusive(Boolean hasAllInclusive)

    • getHasAllInclusive

      @Nullable public Boolean getHasAllInclusive()
      Convenience data point to get to all-inclusive quickly.
      Returns:
      hasAllInclusive

    • setHasAllInclusive

      public void setHasAllInclusive(Boolean hasAllInclusive)

    • hasAllInclusivePlusAlcohol

      public BookingAgent hasAllInclusivePlusAlcohol(Boolean hasAllInclusivePlusAlcohol)

    • getHasAllInclusivePlusAlcohol

      @Nullable public Boolean getHasAllInclusivePlusAlcohol()
      Convenience data point to get to all-inclusive with alcohol quickly.
      Returns:
      hasAllInclusivePlusAlcohol

    • setHasAllInclusivePlusAlcohol

      public void setHasAllInclusivePlusAlcohol(Boolean hasAllInclusivePlusAlcohol)

    • 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