travel.wink.sdk.extranet.booking.model.BeneficiarySupplier Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of extranet-booking-sdk-java Show documentation
Show all versions of extranet-booking-sdk-java Show documentation
Java SDK for the Wink Extranet Booking API
/*
* Wink API
* # Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/engine-client): A single endpoint to retrieve whitelabel + customization information for the booking engine. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Extranet Booking API The Booking API exposes endpoints to manage bookings. This API lets you: 1. Booking: Manage bookings including cancellations. 2. Review: Manage user reviews. 3. Sync w. Calendar: Manage calendar sync with your favorite calendar software Browse the endpoints in the left navigation bar to get started.
*
* The version of the OpenAPI document: 30.4.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package travel.wink.sdk.extranet.booking.model;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import travel.wink.sdk.extranet.booking.model.BeneficiaryChargeSupplier;
import travel.wink.sdk.extranet.booking.model.PendingRefundSupplier;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import jakarta.validation.constraints.*;
import jakarta.validation.Valid;
import org.hibernate.validator.constraints.*;
/**
* Beneficiary is a registered account with rights to compensation within a booking.
*/
@JsonPropertyOrder({
BeneficiarySupplier.JSON_PROPERTY_ACCOUNT_IDENTIFIER,
BeneficiarySupplier.JSON_PROPERTY_ACCOUNT_NAME,
BeneficiarySupplier.JSON_PROPERTY_ACCOUNT_EMAIL,
BeneficiarySupplier.JSON_PROPERTY_ACCOUNT_URL,
BeneficiarySupplier.JSON_PROPERTY_TYPE,
BeneficiarySupplier.JSON_PROPERTY_AMOUNT_DUE,
BeneficiarySupplier.JSON_PROPERTY_SOURCE_CURRENCY,
BeneficiarySupplier.JSON_PROPERTY_DISPLAY_CURRENCY,
BeneficiarySupplier.JSON_PROPERTY_SUPPLIER_CURRENCY,
BeneficiarySupplier.JSON_PROPERTY_INTERNAL_CURRENCY,
BeneficiarySupplier.JSON_PROPERTY_CAPTURE_CURRENCY,
BeneficiarySupplier.JSON_PROPERTY_SOURCE_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_DISPLAY_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_SUPPLIER_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_INTERNAL_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_CAPTURE_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_SOURCE_AMOUNT_REFUND_MODIFIER,
BeneficiarySupplier.JSON_PROPERTY_DISPLAY_AMOUNT_REFUND_MODIFIER,
BeneficiarySupplier.JSON_PROPERTY_SUPPLIER_AMOUNT_REFUND_MODIFIER,
BeneficiarySupplier.JSON_PROPERTY_INTERNAL_AMOUNT_REFUND_MODIFIER,
BeneficiarySupplier.JSON_PROPERTY_CAPTURE_AMOUNT_REFUND_MODIFIER,
BeneficiarySupplier.JSON_PROPERTY_PENDING_REFUNDS,
BeneficiarySupplier.JSON_PROPERTY_NET_SOURCE_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_NET_DISPLAY_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_NET_SUPPLIER_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_NET_INTERNAL_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_NET_CAPTURE_AMOUNT,
BeneficiarySupplier.JSON_PROPERTY_METADATA
})
@JsonTypeName("Beneficiary_Supplier")
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-12T22:10:14.131778200+07:00[Asia/Bangkok]")
public class BeneficiarySupplier {
public static final String JSON_PROPERTY_ACCOUNT_IDENTIFIER = "accountIdentifier";
private String accountIdentifier;
public static final String JSON_PROPERTY_ACCOUNT_NAME = "accountName";
private String accountName;
public static final String JSON_PROPERTY_ACCOUNT_EMAIL = "accountEmail";
private String accountEmail;
public static final String JSON_PROPERTY_ACCOUNT_URL = "accountUrl";
private String accountUrl;
/**
* The type of beneficiary payment.
*/
public enum TypeEnum {
COMMISSION("COMMISSION"),
PLATFORM_FEE("PLATFORM_FEE"),
TRIP_PAY("TRIP_PAY"),
SALE("SALE");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type;
public static final String JSON_PROPERTY_AMOUNT_DUE = "amountDue";
private BeneficiaryChargeSupplier amountDue;
public static final String JSON_PROPERTY_SOURCE_CURRENCY = "sourceCurrency";
private String sourceCurrency;
public static final String JSON_PROPERTY_DISPLAY_CURRENCY = "displayCurrency";
private String displayCurrency;
public static final String JSON_PROPERTY_SUPPLIER_CURRENCY = "supplierCurrency";
private String supplierCurrency;
public static final String JSON_PROPERTY_INTERNAL_CURRENCY = "internalCurrency";
private String internalCurrency;
public static final String JSON_PROPERTY_CAPTURE_CURRENCY = "captureCurrency";
private String captureCurrency;
public static final String JSON_PROPERTY_SOURCE_AMOUNT = "sourceAmount";
private BigDecimal sourceAmount;
public static final String JSON_PROPERTY_DISPLAY_AMOUNT = "displayAmount";
private BigDecimal displayAmount;
public static final String JSON_PROPERTY_SUPPLIER_AMOUNT = "supplierAmount";
private BigDecimal supplierAmount;
public static final String JSON_PROPERTY_INTERNAL_AMOUNT = "internalAmount";
private BigDecimal internalAmount;
public static final String JSON_PROPERTY_CAPTURE_AMOUNT = "captureAmount";
private BigDecimal captureAmount;
public static final String JSON_PROPERTY_SOURCE_AMOUNT_REFUND_MODIFIER = "sourceAmountRefundModifier";
private BigDecimal sourceAmountRefundModifier;
public static final String JSON_PROPERTY_DISPLAY_AMOUNT_REFUND_MODIFIER = "displayAmountRefundModifier";
private BigDecimal displayAmountRefundModifier;
public static final String JSON_PROPERTY_SUPPLIER_AMOUNT_REFUND_MODIFIER = "supplierAmountRefundModifier";
private BigDecimal supplierAmountRefundModifier;
public static final String JSON_PROPERTY_INTERNAL_AMOUNT_REFUND_MODIFIER = "internalAmountRefundModifier";
private BigDecimal internalAmountRefundModifier;
public static final String JSON_PROPERTY_CAPTURE_AMOUNT_REFUND_MODIFIER = "captureAmountRefundModifier";
private BigDecimal captureAmountRefundModifier;
public static final String JSON_PROPERTY_PENDING_REFUNDS = "pendingRefunds";
private List pendingRefunds;
public static final String JSON_PROPERTY_NET_SOURCE_AMOUNT = "netSourceAmount";
private BigDecimal netSourceAmount;
public static final String JSON_PROPERTY_NET_DISPLAY_AMOUNT = "netDisplayAmount";
private BigDecimal netDisplayAmount;
public static final String JSON_PROPERTY_NET_SUPPLIER_AMOUNT = "netSupplierAmount";
private BigDecimal netSupplierAmount;
public static final String JSON_PROPERTY_NET_INTERNAL_AMOUNT = "netInternalAmount";
private BigDecimal netInternalAmount;
public static final String JSON_PROPERTY_NET_CAPTURE_AMOUNT = "netCaptureAmount";
private BigDecimal netCaptureAmount;
public static final String JSON_PROPERTY_METADATA = "metadata";
private Map metadata = new HashMap<>();
public BeneficiarySupplier() {
}
public BeneficiarySupplier accountIdentifier(String accountIdentifier) {
this.accountIdentifier = accountIdentifier;
return this;
}
/**
* accountIdentifier of beneficiary that can map to an account with us
* @return accountIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAccountIdentifier() {
return accountIdentifier;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAccountIdentifier(String accountIdentifier) {
this.accountIdentifier = accountIdentifier;
}
public BeneficiarySupplier accountName(String accountName) {
this.accountName = accountName;
return this;
}
/**
* accountName of beneficiary that can map to an account with us
* @return accountName
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_ACCOUNT_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAccountName() {
return accountName;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAccountName(String accountName) {
this.accountName = accountName;
}
public BeneficiarySupplier accountEmail(String accountEmail) {
this.accountEmail = accountEmail;
return this;
}
/**
* accountEmail of beneficiary that can map to an account with us
* @return accountEmail
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_ACCOUNT_EMAIL)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAccountEmail() {
return accountEmail;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_EMAIL)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAccountEmail(String accountEmail) {
this.accountEmail = accountEmail;
}
public BeneficiarySupplier accountUrl(String accountUrl) {
this.accountUrl = accountUrl;
return this;
}
/**
* accountUrl of beneficiary that can map to an account with us
* @return accountUrl
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ACCOUNT_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAccountUrl() {
return accountUrl;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAccountUrl(String accountUrl) {
this.accountUrl = accountUrl;
}
public BeneficiarySupplier type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The type of beneficiary payment.
* @return type
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public TypeEnum getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setType(TypeEnum type) {
this.type = type;
}
public BeneficiarySupplier amountDue(BeneficiaryChargeSupplier amountDue) {
this.amountDue = amountDue;
return this;
}
/**
* Get amountDue
* @return amountDue
**/
@jakarta.annotation.Nullable
@Valid
@JsonProperty(JSON_PROPERTY_AMOUNT_DUE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public BeneficiaryChargeSupplier getAmountDue() {
return amountDue;
}
@JsonProperty(JSON_PROPERTY_AMOUNT_DUE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAmountDue(BeneficiaryChargeSupplier amountDue) {
this.amountDue = amountDue;
}
public BeneficiarySupplier sourceCurrency(String sourceCurrency) {
this.sourceCurrency = sourceCurrency;
return this;
}
/**
* The source currency
* @return sourceCurrency
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_SOURCE_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSourceCurrency() {
return sourceCurrency;
}
@JsonProperty(JSON_PROPERTY_SOURCE_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSourceCurrency(String sourceCurrency) {
this.sourceCurrency = sourceCurrency;
}
public BeneficiarySupplier displayCurrency(String displayCurrency) {
this.displayCurrency = displayCurrency;
return this;
}
/**
* The display currency
* @return displayCurrency
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_DISPLAY_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getDisplayCurrency() {
return displayCurrency;
}
@JsonProperty(JSON_PROPERTY_DISPLAY_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setDisplayCurrency(String displayCurrency) {
this.displayCurrency = displayCurrency;
}
public BeneficiarySupplier supplierCurrency(String supplierCurrency) {
this.supplierCurrency = supplierCurrency;
return this;
}
/**
* The supplier currency
* @return supplierCurrency
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_SUPPLIER_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSupplierCurrency() {
return supplierCurrency;
}
@JsonProperty(JSON_PROPERTY_SUPPLIER_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSupplierCurrency(String supplierCurrency) {
this.supplierCurrency = supplierCurrency;
}
public BeneficiarySupplier internalCurrency(String internalCurrency) {
this.internalCurrency = internalCurrency;
return this;
}
/**
* The internal currency
* @return internalCurrency
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_INTERNAL_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getInternalCurrency() {
return internalCurrency;
}
@JsonProperty(JSON_PROPERTY_INTERNAL_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setInternalCurrency(String internalCurrency) {
this.internalCurrency = internalCurrency;
}
public BeneficiarySupplier captureCurrency(String captureCurrency) {
this.captureCurrency = captureCurrency;
return this;
}
/**
* The capture currency
* @return captureCurrency
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_CAPTURE_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getCaptureCurrency() {
return captureCurrency;
}
@JsonProperty(JSON_PROPERTY_CAPTURE_CURRENCY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCaptureCurrency(String captureCurrency) {
this.captureCurrency = captureCurrency;
}
public BeneficiarySupplier sourceAmount(BigDecimal sourceAmount) {
this.sourceAmount = sourceAmount;
return this;
}
/**
* Amount in source currency
* minimum: 0
* @return sourceAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_SOURCE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getSourceAmount() {
return sourceAmount;
}
@JsonProperty(JSON_PROPERTY_SOURCE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSourceAmount(BigDecimal sourceAmount) {
this.sourceAmount = sourceAmount;
}
public BeneficiarySupplier displayAmount(BigDecimal displayAmount) {
this.displayAmount = displayAmount;
return this;
}
/**
* Amount in display currency
* minimum: 0
* @return displayAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_DISPLAY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getDisplayAmount() {
return displayAmount;
}
@JsonProperty(JSON_PROPERTY_DISPLAY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setDisplayAmount(BigDecimal displayAmount) {
this.displayAmount = displayAmount;
}
public BeneficiarySupplier supplierAmount(BigDecimal supplierAmount) {
this.supplierAmount = supplierAmount;
return this;
}
/**
* Amount in supplier currency
* minimum: 0
* @return supplierAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_SUPPLIER_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getSupplierAmount() {
return supplierAmount;
}
@JsonProperty(JSON_PROPERTY_SUPPLIER_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSupplierAmount(BigDecimal supplierAmount) {
this.supplierAmount = supplierAmount;
}
public BeneficiarySupplier internalAmount(BigDecimal internalAmount) {
this.internalAmount = internalAmount;
return this;
}
/**
* Amount in internal currency
* minimum: 0
* @return internalAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_INTERNAL_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getInternalAmount() {
return internalAmount;
}
@JsonProperty(JSON_PROPERTY_INTERNAL_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setInternalAmount(BigDecimal internalAmount) {
this.internalAmount = internalAmount;
}
public BeneficiarySupplier captureAmount(BigDecimal captureAmount) {
this.captureAmount = captureAmount;
return this;
}
/**
* Amount in capture currency
* minimum: 0
* @return captureAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_CAPTURE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getCaptureAmount() {
return captureAmount;
}
@JsonProperty(JSON_PROPERTY_CAPTURE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCaptureAmount(BigDecimal captureAmount) {
this.captureAmount = captureAmount;
}
public BeneficiarySupplier sourceAmountRefundModifier(BigDecimal sourceAmountRefundModifier) {
this.sourceAmountRefundModifier = sourceAmountRefundModifier;
return this;
}
/**
* The delta from the original source amount after a refund occurred
* minimum: 0
* @return sourceAmountRefundModifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_SOURCE_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getSourceAmountRefundModifier() {
return sourceAmountRefundModifier;
}
@JsonProperty(JSON_PROPERTY_SOURCE_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSourceAmountRefundModifier(BigDecimal sourceAmountRefundModifier) {
this.sourceAmountRefundModifier = sourceAmountRefundModifier;
}
public BeneficiarySupplier displayAmountRefundModifier(BigDecimal displayAmountRefundModifier) {
this.displayAmountRefundModifier = displayAmountRefundModifier;
return this;
}
/**
* The delta from the original display amount after a refund occurred
* minimum: 0
* @return displayAmountRefundModifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_DISPLAY_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getDisplayAmountRefundModifier() {
return displayAmountRefundModifier;
}
@JsonProperty(JSON_PROPERTY_DISPLAY_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setDisplayAmountRefundModifier(BigDecimal displayAmountRefundModifier) {
this.displayAmountRefundModifier = displayAmountRefundModifier;
}
public BeneficiarySupplier supplierAmountRefundModifier(BigDecimal supplierAmountRefundModifier) {
this.supplierAmountRefundModifier = supplierAmountRefundModifier;
return this;
}
/**
* The delta from the original supplier amount after a refund occurred
* minimum: 0
* @return supplierAmountRefundModifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_SUPPLIER_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getSupplierAmountRefundModifier() {
return supplierAmountRefundModifier;
}
@JsonProperty(JSON_PROPERTY_SUPPLIER_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSupplierAmountRefundModifier(BigDecimal supplierAmountRefundModifier) {
this.supplierAmountRefundModifier = supplierAmountRefundModifier;
}
public BeneficiarySupplier internalAmountRefundModifier(BigDecimal internalAmountRefundModifier) {
this.internalAmountRefundModifier = internalAmountRefundModifier;
return this;
}
/**
* The delta from the original internal amount after a refund occurred
* minimum: 0
* @return internalAmountRefundModifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_INTERNAL_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getInternalAmountRefundModifier() {
return internalAmountRefundModifier;
}
@JsonProperty(JSON_PROPERTY_INTERNAL_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setInternalAmountRefundModifier(BigDecimal internalAmountRefundModifier) {
this.internalAmountRefundModifier = internalAmountRefundModifier;
}
public BeneficiarySupplier captureAmountRefundModifier(BigDecimal captureAmountRefundModifier) {
this.captureAmountRefundModifier = captureAmountRefundModifier;
return this;
}
/**
* The delta from the original capture amount after a refund occurred
* minimum: 0
* @return captureAmountRefundModifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_CAPTURE_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getCaptureAmountRefundModifier() {
return captureAmountRefundModifier;
}
@JsonProperty(JSON_PROPERTY_CAPTURE_AMOUNT_REFUND_MODIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCaptureAmountRefundModifier(BigDecimal captureAmountRefundModifier) {
this.captureAmountRefundModifier = captureAmountRefundModifier;
}
public BeneficiarySupplier pendingRefunds(List pendingRefunds) {
this.pendingRefunds = pendingRefunds;
return this;
}
public BeneficiarySupplier addPendingRefundsItem(PendingRefundSupplier pendingRefundsItem) {
if (this.pendingRefunds == null) {
this.pendingRefunds = new ArrayList<>();
}
this.pendingRefunds.add(pendingRefundsItem);
return this;
}
/**
* Get pendingRefunds
* @return pendingRefunds
**/
@jakarta.annotation.Nullable
@Valid
@JsonProperty(JSON_PROPERTY_PENDING_REFUNDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getPendingRefunds() {
return pendingRefunds;
}
@JsonProperty(JSON_PROPERTY_PENDING_REFUNDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPendingRefunds(List pendingRefunds) {
this.pendingRefunds = pendingRefunds;
}
public BeneficiarySupplier netSourceAmount(BigDecimal netSourceAmount) {
this.netSourceAmount = netSourceAmount;
return this;
}
/**
* Source amount minus source modifier.
* minimum: 0
* @return netSourceAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_NET_SOURCE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getNetSourceAmount() {
return netSourceAmount;
}
@JsonProperty(JSON_PROPERTY_NET_SOURCE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setNetSourceAmount(BigDecimal netSourceAmount) {
this.netSourceAmount = netSourceAmount;
}
public BeneficiarySupplier netDisplayAmount(BigDecimal netDisplayAmount) {
this.netDisplayAmount = netDisplayAmount;
return this;
}
/**
* Display amount minus display modifier.
* minimum: 0
* @return netDisplayAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_NET_DISPLAY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getNetDisplayAmount() {
return netDisplayAmount;
}
@JsonProperty(JSON_PROPERTY_NET_DISPLAY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setNetDisplayAmount(BigDecimal netDisplayAmount) {
this.netDisplayAmount = netDisplayAmount;
}
public BeneficiarySupplier netSupplierAmount(BigDecimal netSupplierAmount) {
this.netSupplierAmount = netSupplierAmount;
return this;
}
/**
* Supplier amount minus supplier modifier.
* minimum: 0
* @return netSupplierAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_NET_SUPPLIER_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getNetSupplierAmount() {
return netSupplierAmount;
}
@JsonProperty(JSON_PROPERTY_NET_SUPPLIER_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setNetSupplierAmount(BigDecimal netSupplierAmount) {
this.netSupplierAmount = netSupplierAmount;
}
public BeneficiarySupplier netInternalAmount(BigDecimal netInternalAmount) {
this.netInternalAmount = netInternalAmount;
return this;
}
/**
* Internal amount minus internal modifier.
* minimum: 0
* @return netInternalAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_NET_INTERNAL_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getNetInternalAmount() {
return netInternalAmount;
}
@JsonProperty(JSON_PROPERTY_NET_INTERNAL_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setNetInternalAmount(BigDecimal netInternalAmount) {
this.netInternalAmount = netInternalAmount;
}
public BeneficiarySupplier netCaptureAmount(BigDecimal netCaptureAmount) {
this.netCaptureAmount = netCaptureAmount;
return this;
}
/**
* Capture amount minus capture modifier.
* minimum: 0
* @return netCaptureAmount
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@DecimalMin("0")
@JsonProperty(JSON_PROPERTY_NET_CAPTURE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public BigDecimal getNetCaptureAmount() {
return netCaptureAmount;
}
@JsonProperty(JSON_PROPERTY_NET_CAPTURE_AMOUNT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setNetCaptureAmount(BigDecimal netCaptureAmount) {
this.netCaptureAmount = netCaptureAmount;
}
public BeneficiarySupplier metadata(Map metadata) {
this.metadata = metadata;
return this;
}
public BeneficiarySupplier putMetadataItem(String key, String metadataItem) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, metadataItem);
return this;
}
/**
* Place to add more data related to the beneficiary.
* @return metadata
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Map getMetadata() {
return metadata;
}
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMetadata(Map metadata) {
this.metadata = metadata;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BeneficiarySupplier beneficiarySupplier = (BeneficiarySupplier) o;
return Objects.equals(this.accountIdentifier, beneficiarySupplier.accountIdentifier) &&
Objects.equals(this.accountName, beneficiarySupplier.accountName) &&
Objects.equals(this.accountEmail, beneficiarySupplier.accountEmail) &&
Objects.equals(this.accountUrl, beneficiarySupplier.accountUrl) &&
Objects.equals(this.type, beneficiarySupplier.type) &&
Objects.equals(this.amountDue, beneficiarySupplier.amountDue) &&
Objects.equals(this.sourceCurrency, beneficiarySupplier.sourceCurrency) &&
Objects.equals(this.displayCurrency, beneficiarySupplier.displayCurrency) &&
Objects.equals(this.supplierCurrency, beneficiarySupplier.supplierCurrency) &&
Objects.equals(this.internalCurrency, beneficiarySupplier.internalCurrency) &&
Objects.equals(this.captureCurrency, beneficiarySupplier.captureCurrency) &&
Objects.equals(this.sourceAmount, beneficiarySupplier.sourceAmount) &&
Objects.equals(this.displayAmount, beneficiarySupplier.displayAmount) &&
Objects.equals(this.supplierAmount, beneficiarySupplier.supplierAmount) &&
Objects.equals(this.internalAmount, beneficiarySupplier.internalAmount) &&
Objects.equals(this.captureAmount, beneficiarySupplier.captureAmount) &&
Objects.equals(this.sourceAmountRefundModifier, beneficiarySupplier.sourceAmountRefundModifier) &&
Objects.equals(this.displayAmountRefundModifier, beneficiarySupplier.displayAmountRefundModifier) &&
Objects.equals(this.supplierAmountRefundModifier, beneficiarySupplier.supplierAmountRefundModifier) &&
Objects.equals(this.internalAmountRefundModifier, beneficiarySupplier.internalAmountRefundModifier) &&
Objects.equals(this.captureAmountRefundModifier, beneficiarySupplier.captureAmountRefundModifier) &&
Objects.equals(this.pendingRefunds, beneficiarySupplier.pendingRefunds) &&
Objects.equals(this.netSourceAmount, beneficiarySupplier.netSourceAmount) &&
Objects.equals(this.netDisplayAmount, beneficiarySupplier.netDisplayAmount) &&
Objects.equals(this.netSupplierAmount, beneficiarySupplier.netSupplierAmount) &&
Objects.equals(this.netInternalAmount, beneficiarySupplier.netInternalAmount) &&
Objects.equals(this.netCaptureAmount, beneficiarySupplier.netCaptureAmount) &&
Objects.equals(this.metadata, beneficiarySupplier.metadata);
}
@Override
public int hashCode() {
return Objects.hash(accountIdentifier, accountName, accountEmail, accountUrl, type, amountDue, sourceCurrency, displayCurrency, supplierCurrency, internalCurrency, captureCurrency, sourceAmount, displayAmount, supplierAmount, internalAmount, captureAmount, sourceAmountRefundModifier, displayAmountRefundModifier, supplierAmountRefundModifier, internalAmountRefundModifier, captureAmountRefundModifier, pendingRefunds, netSourceAmount, netDisplayAmount, netSupplierAmount, netInternalAmount, netCaptureAmount, metadata);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BeneficiarySupplier {\n");
sb.append(" accountIdentifier: ").append(toIndentedString(accountIdentifier)).append("\n");
sb.append(" accountName: ").append(toIndentedString(accountName)).append("\n");
sb.append(" accountEmail: ").append(toIndentedString(accountEmail)).append("\n");
sb.append(" accountUrl: ").append(toIndentedString(accountUrl)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" amountDue: ").append(toIndentedString(amountDue)).append("\n");
sb.append(" sourceCurrency: ").append(toIndentedString(sourceCurrency)).append("\n");
sb.append(" displayCurrency: ").append(toIndentedString(displayCurrency)).append("\n");
sb.append(" supplierCurrency: ").append(toIndentedString(supplierCurrency)).append("\n");
sb.append(" internalCurrency: ").append(toIndentedString(internalCurrency)).append("\n");
sb.append(" captureCurrency: ").append(toIndentedString(captureCurrency)).append("\n");
sb.append(" sourceAmount: ").append(toIndentedString(sourceAmount)).append("\n");
sb.append(" displayAmount: ").append(toIndentedString(displayAmount)).append("\n");
sb.append(" supplierAmount: ").append(toIndentedString(supplierAmount)).append("\n");
sb.append(" internalAmount: ").append(toIndentedString(internalAmount)).append("\n");
sb.append(" captureAmount: ").append(toIndentedString(captureAmount)).append("\n");
sb.append(" sourceAmountRefundModifier: ").append(toIndentedString(sourceAmountRefundModifier)).append("\n");
sb.append(" displayAmountRefundModifier: ").append(toIndentedString(displayAmountRefundModifier)).append("\n");
sb.append(" supplierAmountRefundModifier: ").append(toIndentedString(supplierAmountRefundModifier)).append("\n");
sb.append(" internalAmountRefundModifier: ").append(toIndentedString(internalAmountRefundModifier)).append("\n");
sb.append(" captureAmountRefundModifier: ").append(toIndentedString(captureAmountRefundModifier)).append("\n");
sb.append(" pendingRefunds: ").append(toIndentedString(pendingRefunds)).append("\n");
sb.append(" netSourceAmount: ").append(toIndentedString(netSourceAmount)).append("\n");
sb.append(" netDisplayAmount: ").append(toIndentedString(netDisplayAmount)).append("\n");
sb.append(" netSupplierAmount: ").append(toIndentedString(netSupplierAmount)).append("\n");
sb.append(" netInternalAmount: ").append(toIndentedString(netInternalAmount)).append("\n");
sb.append(" netCaptureAmount: ").append(toIndentedString(netCaptureAmount)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}