Class BookingContractItemAgent
java.lang.Object
travel.wink.sdk.travel.agent.model.BookingContractItemAgent
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-12-27T09:39:31.477717564+07:00[Asia/Bangkok]")
public class BookingContractItemAgent
extends Object
Returns the lodging item only.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumWhen to charge for this item.static enumHow to calculate the total amount.static enumType of item this is. -
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 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 TypeMethodDescriptionaddBeneficiaryListItem(BeneficiaryAgent beneficiaryListItem) addDailyRateListItem(DailyRateAgent dailyRateListItem) beneficiaryList(List<BeneficiaryAgent> beneficiaryList) cancellableBySupplierOrAgent(Boolean cancellableBySupplierOrAgent) cancellableByTraveler(Boolean cancellableByTraveler) cancellableWithNoCharges(Boolean cancellableWithNoCharges) cancellableWithPotentialCharges(Boolean cancellableWithPotentialCharges) captureAmount(BigDecimal captureAmount) captureAmountRefundModifier(BigDecimal captureAmountRefundModifier) captureCurrency(String captureCurrency) dailyRateList(List<DailyRateAgent> dailyRateList) descriptionInEnglish(String descriptionInEnglish) displayAmount(BigDecimal displayAmount) displayAmountRefundModifier(BigDecimal displayAmountRefundModifier) displayCurrency(String displayCurrency) booleanexternalIdentifier(String externalIdentifier) @NotNull @Valid @Size(min=1,max=2147483647) List<BeneficiaryAgent> Get beneficiaryListWhether the booking can still be cancelled by the supplier.Whether the booking can still be cancelled by the traveller.Whether the booking can still be cancelled and whether cancellation charges might still occur.Whether the booking can still be cancelled and whether cancellation charges might still occur.Optional geoname externalIdentifier to remote inventory.@NotNull @Valid @DecimalMin("0") BigDecimalThe total capture price.@Valid @DecimalMin("0") BigDecimalThe capture amount still due after a partial refund occurs.@NotNull StringThe capture currency@Valid List<DailyRateAgent> Get dailyRateList@NotNull StringShort description in English of item included in booking.@NotNull @Valid @DecimalMin("0") BigDecimalThe total display price.@Valid @DecimalMin("0") BigDecimalThe display amount still due after a partial refund occurs.@NotNull StringThe display currencyOptional externalIdentifier to remote inventory.@NotNull @Valid @DecimalMin("0") BigDecimalThe total internal price.@Valid @DecimalMin("0") BigDecimalThe internal amount still due after a partial refund occurs.@NotNull StringThe internal currency@NotNull @Valid SimpleDateTimeItineraryAgentGet itineraryPlace to add more data related to the booking contract item.@NotNull StringName of item in English included in booking.@NotNull @Valid @DecimalMin("0") BigDecimalCapture amount minus capture modifier.@NotNull @Valid @DecimalMin("0") BigDecimalDisplay amount minus display modifier.@NotNull @Valid @DecimalMin("0") BigDecimalInternal amount minus internal modifier.@NotNull @Valid @DecimalMin("0") BigDecimalSource amount minus source modifier.@NotNull @Valid @DecimalMin("0") BigDecimalSupplier amount minus supplier modifier.@NotNull BookingContractItemAgent.PayableEnumWhen to charge for this item.Get policyHow to calculate the total amount.@NotNull @Valid @DecimalMin("0") BigDecimalThe total initial price as quoted in the original TripPay contract.@Valid @DecimalMin("0") BigDecimalThe source amount still due after a partial refund occurs.@NotNull StringThe source currency@NotNull @Valid @DecimalMin("0") BigDecimalThe total supplier price.@Valid @DecimalMin("0") BigDecimalThe supplier amount still due after a partial refund occurs.@NotNull StringThe supplier currency@NotNull StringBooking code identifying the supplier line item.Tokens minted for this item@NotNull BookingContractItemAgent.TypeEnumgetType()Type of item this is.@NotNull @Valid GuestUserAgentgetUser()Get userinthashCode()internalAmount(BigDecimal internalAmount) internalAmountRefundModifier(BigDecimal internalAmountRefundModifier) internalCurrency(String internalCurrency) itinerary(SimpleDateTimeItineraryAgent itinerary) nameInEnglish(String nameInEnglish) netCaptureAmount(BigDecimal netCaptureAmount) netDisplayAmount(BigDecimal netDisplayAmount) netInternalAmount(BigDecimal netInternalAmount) netSourceAmount(BigDecimal netSourceAmount) netSupplierAmount(BigDecimal netSupplierAmount) pricingType(BookingContractItemAgent.PricingTypeEnum pricingType) putMetadataItem(String key, String metadataItem) voidsetBeneficiaryList(List<BeneficiaryAgent> beneficiaryList) voidsetCancellableBySupplierOrAgent(Boolean cancellableBySupplierOrAgent) voidsetCancellableByTraveler(Boolean cancellableByTraveler) voidsetCancellableWithNoCharges(Boolean cancellableWithNoCharges) voidsetCancellableWithPotentialCharges(Boolean cancellableWithPotentialCharges) voidsetCancelled(Boolean cancelled) voidsetCaptureAmount(BigDecimal captureAmount) voidsetCaptureAmountRefundModifier(BigDecimal captureAmountRefundModifier) voidsetCaptureCurrency(String captureCurrency) voidsetDailyRateList(List<DailyRateAgent> dailyRateList) voidsetDescriptionInEnglish(String descriptionInEnglish) voidsetDisplayAmount(BigDecimal displayAmount) voidsetDisplayAmountRefundModifier(BigDecimal displayAmountRefundModifier) voidsetDisplayCurrency(String displayCurrency) voidsetExternalIdentifier(String externalIdentifier) voidsetInternalAmount(BigDecimal internalAmount) voidsetInternalAmountRefundModifier(BigDecimal internalAmountRefundModifier) voidsetInternalCurrency(String internalCurrency) voidsetItinerary(SimpleDateTimeItineraryAgent itinerary) voidsetMetadata(Map<String, String> metadata) voidsetNameInEnglish(String nameInEnglish) voidsetNetCaptureAmount(BigDecimal netCaptureAmount) voidsetNetDisplayAmount(BigDecimal netDisplayAmount) voidsetNetInternalAmount(BigDecimal netInternalAmount) voidsetNetSourceAmount(BigDecimal netSourceAmount) voidsetNetSupplierAmount(BigDecimal netSupplierAmount) voidvoidvoidsetPricingType(BookingContractItemAgent.PricingTypeEnum pricingType) voidsetSourceAmount(BigDecimal sourceAmount) voidsetSourceAmountRefundModifier(BigDecimal sourceAmountRefundModifier) voidsetSourceCurrency(String sourceCurrency) voidsetSupplierAmount(BigDecimal supplierAmount) voidsetSupplierAmountRefundModifier(BigDecimal supplierAmountRefundModifier) voidsetSupplierCurrency(String supplierCurrency) voidsetSupplierItemBookingCode(String supplierItemBookingCode) voidsetTokensEarned(Long tokensEarned) voidvoidsetUser(GuestUserAgent user) sourceAmount(BigDecimal sourceAmount) sourceAmountRefundModifier(BigDecimal sourceAmountRefundModifier) sourceCurrency(String sourceCurrency) supplierAmount(BigDecimal supplierAmount) supplierAmountRefundModifier(BigDecimal supplierAmountRefundModifier) supplierCurrency(String supplierCurrency) supplierItemBookingCode(String supplierItemBookingCode) tokensEarned(Long tokensEarned) toString()user(GuestUserAgent user)
-
Field Details
-
JSON_PROPERTY_SUPPLIER_ITEM_BOOKING_CODE
- See Also:
-
JSON_PROPERTY_USER
- See Also:
-
JSON_PROPERTY_NAME_IN_ENGLISH
- See Also:
-
JSON_PROPERTY_DESCRIPTION_IN_ENGLISH
- See Also:
-
JSON_PROPERTY_ITINERARY
- See Also:
-
JSON_PROPERTY_PRICING_TYPE
- See Also:
-
JSON_PROPERTY_TYPE
- See Also:
-
JSON_PROPERTY_BENEFICIARY_LIST
- See Also:
-
JSON_PROPERTY_PAYABLE
- See Also:
-
JSON_PROPERTY_POLICY
- See Also:
-
JSON_PROPERTY_EXTERNAL_IDENTIFIER
- See Also:
-
JSON_PROPERTY_TOKENS_EARNED
- See Also:
-
JSON_PROPERTY_DAILY_RATE_LIST
- See Also:
-
JSON_PROPERTY_CANCELLED
- See Also:
-
JSON_PROPERTY_SOURCE_CURRENCY
- See Also:
-
JSON_PROPERTY_DISPLAY_CURRENCY
- See Also:
-
JSON_PROPERTY_SUPPLIER_CURRENCY
- See Also:
-
JSON_PROPERTY_INTERNAL_CURRENCY
- See Also:
-
JSON_PROPERTY_CAPTURE_CURRENCY
- See Also:
-
JSON_PROPERTY_SOURCE_AMOUNT
- See Also:
-
JSON_PROPERTY_DISPLAY_AMOUNT
- See Also:
-
JSON_PROPERTY_SUPPLIER_AMOUNT
- See Also:
-
JSON_PROPERTY_INTERNAL_AMOUNT
- See Also:
-
JSON_PROPERTY_CAPTURE_AMOUNT
- See Also:
-
JSON_PROPERTY_SOURCE_AMOUNT_REFUND_MODIFIER
- See Also:
-
JSON_PROPERTY_DISPLAY_AMOUNT_REFUND_MODIFIER
- See Also:
-
JSON_PROPERTY_SUPPLIER_AMOUNT_REFUND_MODIFIER
- See Also:
-
JSON_PROPERTY_INTERNAL_AMOUNT_REFUND_MODIFIER
- See Also:
-
JSON_PROPERTY_CAPTURE_AMOUNT_REFUND_MODIFIER
- See Also:
-
JSON_PROPERTY_NET_SOURCE_AMOUNT
- See Also:
-
JSON_PROPERTY_NET_DISPLAY_AMOUNT
- See Also:
-
JSON_PROPERTY_NET_SUPPLIER_AMOUNT
- See Also:
-
JSON_PROPERTY_NET_INTERNAL_AMOUNT
- See Also:
-
JSON_PROPERTY_NET_CAPTURE_AMOUNT
- See Also:
-
JSON_PROPERTY_METADATA
- See Also:
-
JSON_PROPERTY_CANCELLABLE_BY_TRAVELER
- See Also:
-
JSON_PROPERTY_CANCELLABLE_WITH_NO_CHARGES
- See Also:
-
JSON_PROPERTY_CANCELLABLE_WITH_POTENTIAL_CHARGES
- See Also:
-
JSON_PROPERTY_CANCELLABLE_BY_SUPPLIER_OR_AGENT
- See Also:
-
-
Constructor Details
-
BookingContractItemAgent
public BookingContractItemAgent()
-
-
Method Details
-
supplierItemBookingCode
-
getSupplierItemBookingCode
Booking code identifying the supplier line item.- Returns:
- supplierItemBookingCode
-
setSupplierItemBookingCode
-
user
-
getUser
-
setUser
-
nameInEnglish
-
getNameInEnglish
Name of item in English included in booking.- Returns:
- nameInEnglish
-
setNameInEnglish
-
descriptionInEnglish
-
getDescriptionInEnglish
Short description in English of item included in booking.- Returns:
- descriptionInEnglish
-
setDescriptionInEnglish
-
itinerary
-
getItinerary
Get itinerary- Returns:
- itinerary
-
setItinerary
-
pricingType
-
getPricingType
How to calculate the total amount.- Returns:
- pricingType
-
setPricingType
-
type
-
getType
Type of item this is.- Returns:
- type
-
setType
-
beneficiaryList
-
addBeneficiaryListItem
-
getBeneficiaryList
@Nonnull @NotNull @Valid @Size(min=1, max=2147483647) public @NotNull @Valid @Size(min=1,max=2147483647) List<BeneficiaryAgent> getBeneficiaryList()Get beneficiaryList- Returns:
- beneficiaryList
-
setBeneficiaryList
-
payable
-
getPayable
When to charge for this item.- Returns:
- payable
-
setPayable
-
policy
-
getPolicy
Get policy- Returns:
- policy
-
setPolicy
-
externalIdentifier
-
getExternalIdentifier
Optional externalIdentifier to remote inventory.- Returns:
- externalIdentifier
-
setExternalIdentifier
-
tokensEarned
-
getTokensEarned
-
setTokensEarned
-
dailyRateList
-
addDailyRateListItem
-
getDailyRateList
Get dailyRateList- Returns:
- dailyRateList
-
setDailyRateList
-
cancelled
-
getCancelled
Optional geoname externalIdentifier to remote inventory.- Returns:
- cancelled
-
setCancelled
-
sourceCurrency
-
getSourceCurrency
The source currency- Returns:
- sourceCurrency
-
setSourceCurrency
-
displayCurrency
-
getDisplayCurrency
The display currency- Returns:
- displayCurrency
-
setDisplayCurrency
-
supplierCurrency
-
getSupplierCurrency
The supplier currency- Returns:
- supplierCurrency
-
setSupplierCurrency
-
internalCurrency
-
getInternalCurrency
The internal currency- Returns:
- internalCurrency
-
setInternalCurrency
-
captureCurrency
-
getCaptureCurrency
The capture currency- Returns:
- captureCurrency
-
setCaptureCurrency
-
sourceAmount
-
getSourceAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getSourceAmount()The total initial price as quoted in the original TripPay contract. minimum: 0- Returns:
- sourceAmount
-
setSourceAmount
-
displayAmount
-
getDisplayAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getDisplayAmount()The total display price. minimum: 0- Returns:
- displayAmount
-
setDisplayAmount
-
supplierAmount
-
getSupplierAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getSupplierAmount()The total supplier price. minimum: 0- Returns:
- supplierAmount
-
setSupplierAmount
-
internalAmount
-
getInternalAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getInternalAmount()The total internal price. minimum: 0- Returns:
- internalAmount
-
setInternalAmount
-
captureAmount
-
getCaptureAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getCaptureAmount()The total capture price. minimum: 0- Returns:
- captureAmount
-
setCaptureAmount
-
sourceAmountRefundModifier
-
getSourceAmountRefundModifier
@Nullable @Valid @DecimalMin("0") public @Valid @DecimalMin("0") BigDecimal getSourceAmountRefundModifier()The source amount still due after a partial refund occurs. minimum: 0- Returns:
- sourceAmountRefundModifier
-
setSourceAmountRefundModifier
-
displayAmountRefundModifier
-
getDisplayAmountRefundModifier
@Nullable @Valid @DecimalMin("0") public @Valid @DecimalMin("0") BigDecimal getDisplayAmountRefundModifier()The display amount still due after a partial refund occurs. minimum: 0- Returns:
- displayAmountRefundModifier
-
setDisplayAmountRefundModifier
-
supplierAmountRefundModifier
public BookingContractItemAgent supplierAmountRefundModifier(BigDecimal supplierAmountRefundModifier) -
getSupplierAmountRefundModifier
@Nullable @Valid @DecimalMin("0") public @Valid @DecimalMin("0") BigDecimal getSupplierAmountRefundModifier()The supplier amount still due after a partial refund occurs. minimum: 0- Returns:
- supplierAmountRefundModifier
-
setSupplierAmountRefundModifier
-
internalAmountRefundModifier
public BookingContractItemAgent internalAmountRefundModifier(BigDecimal internalAmountRefundModifier) -
getInternalAmountRefundModifier
@Nullable @Valid @DecimalMin("0") public @Valid @DecimalMin("0") BigDecimal getInternalAmountRefundModifier()The internal amount still due after a partial refund occurs. minimum: 0- Returns:
- internalAmountRefundModifier
-
setInternalAmountRefundModifier
-
captureAmountRefundModifier
-
getCaptureAmountRefundModifier
@Nullable @Valid @DecimalMin("0") public @Valid @DecimalMin("0") BigDecimal getCaptureAmountRefundModifier()The capture amount still due after a partial refund occurs. minimum: 0- Returns:
- captureAmountRefundModifier
-
setCaptureAmountRefundModifier
-
netSourceAmount
-
getNetSourceAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getNetSourceAmount()Source amount minus source modifier. minimum: 0- Returns:
- netSourceAmount
-
setNetSourceAmount
-
netDisplayAmount
-
getNetDisplayAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getNetDisplayAmount()Display amount minus display modifier. minimum: 0- Returns:
- netDisplayAmount
-
setNetDisplayAmount
-
netSupplierAmount
-
getNetSupplierAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getNetSupplierAmount()Supplier amount minus supplier modifier. minimum: 0- Returns:
- netSupplierAmount
-
setNetSupplierAmount
-
netInternalAmount
-
getNetInternalAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getNetInternalAmount()Internal amount minus internal modifier. minimum: 0- Returns:
- netInternalAmount
-
setNetInternalAmount
-
netCaptureAmount
-
getNetCaptureAmount
@Nonnull @NotNull @Valid @DecimalMin("0") public @NotNull @Valid @DecimalMin("0") BigDecimal getNetCaptureAmount()Capture amount minus capture modifier. minimum: 0- Returns:
- netCaptureAmount
-
setNetCaptureAmount
-
metadata
-
putMetadataItem
-
getMetadata
-
setMetadata
-
cancellableByTraveler
-
getCancellableByTraveler
Whether the booking can still be cancelled by the traveller.- Returns:
- cancellableByTraveler
-
setCancellableByTraveler
-
cancellableWithNoCharges
-
getCancellableWithNoCharges
Whether the booking can still be cancelled and whether cancellation charges might still occur.- Returns:
- cancellableWithNoCharges
-
setCancellableWithNoCharges
-
cancellableWithPotentialCharges
public BookingContractItemAgent cancellableWithPotentialCharges(Boolean cancellableWithPotentialCharges) -
getCancellableWithPotentialCharges
Whether the booking can still be cancelled and whether cancellation charges might still occur.- Returns:
- cancellableWithPotentialCharges
-
setCancellableWithPotentialCharges
-
cancellableBySupplierOrAgent
-
getCancellableBySupplierOrAgent
Whether the booking can still be cancelled by the supplier. A supplier cancellation overrides the refundable- Returns:
- cancellableBySupplierOrAgent
-
setCancellableBySupplierOrAgent
-
equals
-
hashCode
-
toString
-