Package travel.wink.hotelbeds.booking.sdk.model

Class ApiRate

java.lang.Object
travel.wink.hotelbeds.booking.sdk.model.ApiRate
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-10-04T11:28:08.331690043+07:00[Asia/Bangkok]") public class ApiRate extends Object
Definition of a rate.

  • Field Details

  • Constructor Details

    • ApiRate

      public ApiRate()

  • Method Details

    • rateKey

      public ApiRate rateKey(String rateKey)

    • getRateKey

      @Nullable public String getRateKey()
      Internal key that represents a combination of room type, category, board and occupancy. Is returned in Availability and used to valuate a rate and confirm a booking.
      Returns:
      rateKey

    • setRateKey

      public void setRateKey(String rateKey)

    • rateClass

      public ApiRate rateClass(String rateClass)

    • getRateClass

      @Nullable public String getRateClass()
      Class of the rate.
      Returns:
      rateClass

    • setRateClass

      public void setRateClass(String rateClass)

    • rateType

      public ApiRate rateType(ApiRate.RateTypeEnum rateType)

    • getRateType

      @Nullable public ApiRate.RateTypeEnum getRateType()
      Determines if can booked directly (BOOKABLE) or if it needs to be checked with the ‘CheckRate’ operation (RECHECK).
      Returns:
      rateType

    • setRateType

      public void setRateType(ApiRate.RateTypeEnum rateType)

    • net

      public ApiRate net(String net)

    • getNet

      @Nullable public String getNet()
      Net price of the rate.
      Returns:
      net

    • setNet

      public void setNet(String net)

    • discount

      public ApiRate discount(String discount)

    • getDiscount

      @Nullable public String getDiscount()
      Profit margin that the agency would take if it sells at that recommended price.
      Returns:
      discount

    • setDiscount

      public void setDiscount(String discount)

    • discountPCT

      public ApiRate discountPCT(String discountPCT)

    • getDiscountPCT

      @Nullable public String getDiscountPCT()
      Percentual share of the price corresponding to the profit margin the agency would take if it sells at that recommended price.
      Returns:
      discountPCT

    • setDiscountPCT

      public void setDiscountPCT(String discountPCT)

    • sellingRate

      public ApiRate sellingRate(String sellingRate)

    • getSellingRate

      @Nullable public String getSellingRate()
      Gross price of the room in case it is included.
      Returns:
      sellingRate

    • setSellingRate

      public void setSellingRate(String sellingRate)

    • hotelMandatory

      public ApiRate hotelMandatory(Boolean hotelMandatory)

    • getHotelMandatory

      @Nullable public Boolean getHotelMandatory()
      Identifies if the rate price is recommended.
      Returns:
      hotelMandatory

    • setHotelMandatory

      public void setHotelMandatory(Boolean hotelMandatory)

    • allotment

      public ApiRate allotment(Integer allotment)

    • getAllotment

      @Nullable public Integer getAllotment()
      Number of rooms available for a particular room type.
      Returns:
      allotment

    • setAllotment

      public void setAllotment(Integer allotment)

    • commission

      public ApiRate commission(String commission)

    • getCommission

      @Nullable public String getCommission()
      Profit margin the agency takes (commissionable model).
      Returns:
      commission

    • setCommission

      public void setCommission(String commission)

    • commissionVAT

      public ApiRate commissionVAT(String commissionVAT)

    • getCommissionVAT

      @Nullable public String getCommissionVAT()
      Share of the commission corresponding to the Value Added Tax.
      Returns:
      commissionVAT

    • setCommissionVAT

      public void setCommissionVAT(String commissionVAT)

    • commissionPCT

      public ApiRate commissionPCT(String commissionPCT)

    • getCommissionPCT

      @Nullable public String getCommissionPCT()
      Percentual share of the price corresponding to commision.
      Returns:
      commissionPCT

    • setCommissionPCT

      public void setCommissionPCT(String commissionPCT)

    • rateCommentsId

      public ApiRate rateCommentsId(String rateCommentsId)

    • getRateCommentsId

      @Nullable public String getRateCommentsId()
      Comments associated to this rate (more information on [Hotel Content API](/documentation/hotels/content-api/api-reference/) ).
      Returns:
      rateCommentsId

    • setRateCommentsId

      public void setRateCommentsId(String rateCommentsId)

    • rateComments

      public ApiRate rateComments(String rateComments)

    • getRateComments

      @Nullable public String getRateComments()
      Rate comments that contain important information.
      Returns:
      rateComments

    • setRateComments

      public void setRateComments(String rateComments)

    • packaging

      public ApiRate packaging(Boolean packaging)

    • getPackaging

      @Nullable public Boolean getPackaging()
      Defines if the rate is for packaging.
      Returns:
      packaging

    • setPackaging

      public void setPackaging(Boolean packaging)

    • boardCode

      public ApiRate boardCode(String boardCode)

    • getBoardCode

      @Nullable public String getBoardCode()
      Internal board code.
      Returns:
      boardCode

    • setBoardCode

      public void setBoardCode(String boardCode)

    • boardName

      public ApiRate boardName(String boardName)

    • getBoardName

      @Nullable public String getBoardName()
      Board name/description.
      Returns:
      boardName

    • setBoardName

      public void setBoardName(String boardName)

    • rooms

      public ApiRate rooms(Integer rooms)

    • getRooms

      @Nullable public Integer getRooms()
      Number of rooms requested.
      Returns:
      rooms

    • setRooms

      public void setRooms(Integer rooms)

    • adults

      public ApiRate adults(Integer adults)

    • getAdults

      @Nullable public Integer getAdults()
      Number of adults requested for each room.
      Returns:
      adults

    • setAdults

      public void setAdults(Integer adults)

    • children

      public ApiRate children(Integer children)

    • getChildren

      @Nullable public Integer getChildren()
      Number of children requested for each room.
      Returns:
      children

    • setChildren

      public void setChildren(Integer children)

    • childrenAges

      public ApiRate childrenAges(String childrenAges)

    • getChildrenAges

      @Nullable public String getChildrenAges()
      Ages of the children (if any).
      Returns:
      childrenAges

    • setChildrenAges

      public void setChildrenAges(String childrenAges)

    • rateup

      public ApiRate rateup(String rateup)

    • getRateup

      @Nullable public String getRateup()
      Difference between original rate price and upselling rate price.
      Returns:
      rateup

    • setRateup

      public void setRateup(String rateup)

    • brand

      public ApiRate brand(String brand)

    • getBrand

      @Nullable public String getBrand()
      Brand of the hotel.
      Returns:
      brand

    • setBrand

      public void setBrand(String brand)

    • resident

      public ApiRate resident(Boolean resident)

    • getResident

      @Nullable public Boolean getResident()
      Indicates if the rate is only for residents (only appears when resident rates are requested).
      Returns:
      resident

    • setResident

      public void setResident(Boolean resident)

    • cancellationPolicies

      public ApiRate cancellationPolicies(List<ApiCancellationPolicy> cancellationPolicies)

    • addCancellationPoliciesItem

      public ApiRate addCancellationPoliciesItem(ApiCancellationPolicy cancellationPoliciesItem)

    • getCancellationPolicies

      @Nullable @Valid public @Valid List<ApiCancellationPolicy> getCancellationPolicies()
      List of cancellation policies on the rate.
      Returns:
      cancellationPolicies

    • setCancellationPolicies

      public void setCancellationPolicies(List<ApiCancellationPolicy> cancellationPolicies)

    • taxes

      public ApiRate taxes(ApiTaxes taxes)

    • getTaxes

      @Nullable @Valid public @Valid ApiTaxes getTaxes()
      Get taxes
      Returns:
      taxes

    • setTaxes

      public void setTaxes(ApiTaxes taxes)

    • promotions

      public ApiRate promotions(List<ApiPromotion> promotions)

    • addPromotionsItem

      public ApiRate addPromotionsItem(ApiPromotion promotionsItem)

    • getPromotions

      @Nullable @Valid public @Valid List<ApiPromotion> getPromotions()
      List of promotions on the rate.
      Returns:
      promotions

    • setPromotions

      public void setPromotions(List<ApiPromotion> promotions)

    • offers

      public ApiRate offers(List<ApiOffer> offers)

    • addOffersItem

      public ApiRate addOffersItem(ApiOffer offersItem)

    • getOffers

      @Nullable @Valid public @Valid List<ApiOffer> getOffers()
      List of offers on the rate.
      Returns:
      offers

    • setOffers

      public void setOffers(List<ApiOffer> offers)

    • shiftRates

      public ApiRate shiftRates(List<ApiShiftRate> shiftRates)

    • addShiftRatesItem

      public ApiRate addShiftRatesItem(ApiShiftRate shiftRatesItem)

    • getShiftRates

      @Nullable @Valid public @Valid List<ApiShiftRate> getShiftRates()
      Information about rates for alternative dates.
      Returns:
      shiftRates

    • setShiftRates

      public void setShiftRates(List<ApiShiftRate> shiftRates)

    • dailyRates

      public ApiRate dailyRates(List<ApiDailyRate> dailyRates)

    • addDailyRatesItem

      public ApiRate addDailyRatesItem(ApiDailyRate dailyRatesItem)

    • getDailyRates

      @Nullable @Valid public @Valid List<ApiDailyRate> getDailyRates()
      Breakdown of the rate for each day of the stay.
      Returns:
      dailyRates

    • setDailyRates

      public void setDailyRates(List<ApiDailyRate> dailyRates)

    • 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