travel.wink.sdk.extranet.booking.model.BookingContractPaymentDetailsSupplier 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.3.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.time.OffsetDateTime;
import java.time.LocalDateTime;
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.FeeSupplier;
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.*;
/**
* Payment details the merchant provided us at the time of payment.
*/
@JsonPropertyOrder({
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_ACQUIRER_IDENTIFIER,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_VENDOR,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_TRANSACTION_IDENTIFIER,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_CUSTOMER_IDENTIFIER,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_CHARGE_IDENTIFIER,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_STATUS,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_AGENT_INVOICED_DATE,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_AGENT_INVOICE_IDENTIFIER,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_REDIRECT_URL,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_FEES,
BookingContractPaymentDetailsSupplier.JSON_PROPERTY_VENDOR_SPECIFIC
})
@JsonTypeName("BookingContractPaymentDetails_Supplier")
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-12T10:02:23.724204064+07:00[Asia/Bangkok]")
public class BookingContractPaymentDetailsSupplier {
public static final String JSON_PROPERTY_ACQUIRER_IDENTIFIER = "acquirerIdentifier";
private String acquirerIdentifier;
/**
* Name of acquiring vendor
*/
public enum VendorEnum {
STRIPE("STRIPE"),
AGENT("AGENT"),
NMI("NMI"),
WISE("WISE");
private String value;
VendorEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static VendorEnum fromValue(String value) {
for (VendorEnum b : VendorEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_VENDOR = "vendor";
private VendorEnum vendor;
public static final String JSON_PROPERTY_TRANSACTION_IDENTIFIER = "transactionIdentifier";
private String transactionIdentifier;
public static final String JSON_PROPERTY_CUSTOMER_IDENTIFIER = "customerIdentifier";
private String customerIdentifier;
public static final String JSON_PROPERTY_CHARGE_IDENTIFIER = "chargeIdentifier";
private String chargeIdentifier;
/**
* Unique transaction id from the vendor upon a successful sale. Agent adds their transaction identifier.
*/
public enum StatusEnum {
INITIALIZED("INITIALIZED"),
PROCESSING("PROCESSING"),
SUCCEEDED("SUCCEEDED"),
FAILED("FAILED");
private String value;
StatusEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static StatusEnum fromValue(String value) {
for (StatusEnum b : StatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_STATUS = "status";
private StatusEnum status;
public static final String JSON_PROPERTY_AGENT_INVOICED_DATE = "agentInvoicedDate";
private java.time.LocalDateTime agentInvoicedDate;
public static final String JSON_PROPERTY_AGENT_INVOICE_IDENTIFIER = "agentInvoiceIdentifier";
private String agentInvoiceIdentifier;
public static final String JSON_PROPERTY_REDIRECT_URL = "redirectUrl";
private String redirectUrl;
public static final String JSON_PROPERTY_FEES = "fees";
private List fees;
public static final String JSON_PROPERTY_VENDOR_SPECIFIC = "vendorSpecific";
private Map vendorSpecific = new HashMap<>();
public BookingContractPaymentDetailsSupplier() {
}
public BookingContractPaymentDetailsSupplier acquirerIdentifier(String acquirerIdentifier) {
this.acquirerIdentifier = acquirerIdentifier;
return this;
}
/**
* Unique acquiring identifier. Blank for agent payment
* @return acquirerIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_ACQUIRER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAcquirerIdentifier() {
return acquirerIdentifier;
}
@JsonProperty(JSON_PROPERTY_ACQUIRER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAcquirerIdentifier(String acquirerIdentifier) {
this.acquirerIdentifier = acquirerIdentifier;
}
public BookingContractPaymentDetailsSupplier vendor(VendorEnum vendor) {
this.vendor = vendor;
return this;
}
/**
* Name of acquiring vendor
* @return vendor
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_VENDOR)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public VendorEnum getVendor() {
return vendor;
}
@JsonProperty(JSON_PROPERTY_VENDOR)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setVendor(VendorEnum vendor) {
this.vendor = vendor;
}
public BookingContractPaymentDetailsSupplier transactionIdentifier(String transactionIdentifier) {
this.transactionIdentifier = transactionIdentifier;
return this;
}
/**
* Unique transaction id from the vendor. Agent adds their transaction identifier.
* @return transactionIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_TRANSACTION_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getTransactionIdentifier() {
return transactionIdentifier;
}
@JsonProperty(JSON_PROPERTY_TRANSACTION_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setTransactionIdentifier(String transactionIdentifier) {
this.transactionIdentifier = transactionIdentifier;
}
public BookingContractPaymentDetailsSupplier customerIdentifier(String customerIdentifier) {
this.customerIdentifier = customerIdentifier;
return this;
}
/**
* Unique customer id from the vendor. Agent adds their own customer identifier.
* @return customerIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_CUSTOMER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getCustomerIdentifier() {
return customerIdentifier;
}
@JsonProperty(JSON_PROPERTY_CUSTOMER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCustomerIdentifier(String customerIdentifier) {
this.customerIdentifier = customerIdentifier;
}
public BookingContractPaymentDetailsSupplier chargeIdentifier(String chargeIdentifier) {
this.chargeIdentifier = chargeIdentifier;
return this;
}
/**
* Unique charge id from the vendor..
* @return chargeIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_CHARGE_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getChargeIdentifier() {
return chargeIdentifier;
}
@JsonProperty(JSON_PROPERTY_CHARGE_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setChargeIdentifier(String chargeIdentifier) {
this.chargeIdentifier = chargeIdentifier;
}
public BookingContractPaymentDetailsSupplier status(StatusEnum status) {
this.status = status;
return this;
}
/**
* Unique transaction id from the vendor upon a successful sale. Agent adds their transaction identifier.
* @return status
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public StatusEnum getStatus() {
return status;
}
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setStatus(StatusEnum status) {
this.status = status;
}
public BookingContractPaymentDetailsSupplier agentInvoicedDate(java.time.LocalDateTime agentInvoicedDate) {
this.agentInvoicedDate = agentInvoicedDate;
return this;
}
/**
* The date/time the invoice was generated
* @return agentInvoicedDate
**/
@jakarta.annotation.Nullable
@Valid
@JsonProperty(JSON_PROPERTY_AGENT_INVOICED_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public java.time.LocalDateTime getAgentInvoicedDate() {
return agentInvoicedDate;
}
@JsonProperty(JSON_PROPERTY_AGENT_INVOICED_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAgentInvoicedDate(java.time.LocalDateTime agentInvoicedDate) {
this.agentInvoicedDate = agentInvoicedDate;
}
public BookingContractPaymentDetailsSupplier agentInvoiceIdentifier(String agentInvoiceIdentifier) {
this.agentInvoiceIdentifier = agentInvoiceIdentifier;
return this;
}
/**
* The specific invoice this booking was registered on
* @return agentInvoiceIdentifier
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_AGENT_INVOICE_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAgentInvoiceIdentifier() {
return agentInvoiceIdentifier;
}
@JsonProperty(JSON_PROPERTY_AGENT_INVOICE_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAgentInvoiceIdentifier(String agentInvoiceIdentifier) {
this.agentInvoiceIdentifier = agentInvoiceIdentifier;
}
public BookingContractPaymentDetailsSupplier redirectUrl(String redirectUrl) {
this.redirectUrl = redirectUrl;
return this;
}
/**
* Where to redirect to after payment [in-]complete
* @return redirectUrl
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_REDIRECT_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getRedirectUrl() {
return redirectUrl;
}
@JsonProperty(JSON_PROPERTY_REDIRECT_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRedirectUrl(String redirectUrl) {
this.redirectUrl = redirectUrl;
}
public BookingContractPaymentDetailsSupplier fees(List fees) {
this.fees = fees;
return this;
}
public BookingContractPaymentDetailsSupplier addFeesItem(FeeSupplier feesItem) {
if (this.fees == null) {
this.fees = new ArrayList<>();
}
this.fees.add(feesItem);
return this;
}
/**
* Get fees
* @return fees
**/
@jakarta.annotation.Nullable
@Valid
@JsonProperty(JSON_PROPERTY_FEES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getFees() {
return fees;
}
@JsonProperty(JSON_PROPERTY_FEES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFees(List fees) {
this.fees = fees;
}
public BookingContractPaymentDetailsSupplier vendorSpecific(Map vendorSpecific) {
this.vendorSpecific = vendorSpecific;
return this;
}
public BookingContractPaymentDetailsSupplier putVendorSpecificItem(String key, String vendorSpecificItem) {
this.vendorSpecific.put(key, vendorSpecificItem);
return this;
}
/**
* Vendor specific values that are returned in a successful response
* @return vendorSpecific
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_VENDOR_SPECIFIC)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Map getVendorSpecific() {
return vendorSpecific;
}
@JsonProperty(JSON_PROPERTY_VENDOR_SPECIFIC)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setVendorSpecific(Map vendorSpecific) {
this.vendorSpecific = vendorSpecific;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BookingContractPaymentDetailsSupplier bookingContractPaymentDetailsSupplier = (BookingContractPaymentDetailsSupplier) o;
return Objects.equals(this.acquirerIdentifier, bookingContractPaymentDetailsSupplier.acquirerIdentifier) &&
Objects.equals(this.vendor, bookingContractPaymentDetailsSupplier.vendor) &&
Objects.equals(this.transactionIdentifier, bookingContractPaymentDetailsSupplier.transactionIdentifier) &&
Objects.equals(this.customerIdentifier, bookingContractPaymentDetailsSupplier.customerIdentifier) &&
Objects.equals(this.chargeIdentifier, bookingContractPaymentDetailsSupplier.chargeIdentifier) &&
Objects.equals(this.status, bookingContractPaymentDetailsSupplier.status) &&
Objects.equals(this.agentInvoicedDate, bookingContractPaymentDetailsSupplier.agentInvoicedDate) &&
Objects.equals(this.agentInvoiceIdentifier, bookingContractPaymentDetailsSupplier.agentInvoiceIdentifier) &&
Objects.equals(this.redirectUrl, bookingContractPaymentDetailsSupplier.redirectUrl) &&
Objects.equals(this.fees, bookingContractPaymentDetailsSupplier.fees) &&
Objects.equals(this.vendorSpecific, bookingContractPaymentDetailsSupplier.vendorSpecific);
}
@Override
public int hashCode() {
return Objects.hash(acquirerIdentifier, vendor, transactionIdentifier, customerIdentifier, chargeIdentifier, status, agentInvoicedDate, agentInvoiceIdentifier, redirectUrl, fees, vendorSpecific);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BookingContractPaymentDetailsSupplier {\n");
sb.append(" acquirerIdentifier: ").append(toIndentedString(acquirerIdentifier)).append("\n");
sb.append(" vendor: ").append(toIndentedString(vendor)).append("\n");
sb.append(" transactionIdentifier: ").append(toIndentedString(transactionIdentifier)).append("\n");
sb.append(" customerIdentifier: ").append(toIndentedString(customerIdentifier)).append("\n");
sb.append(" chargeIdentifier: ").append(toIndentedString(chargeIdentifier)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" agentInvoicedDate: ").append(toIndentedString(agentInvoicedDate)).append("\n");
sb.append(" agentInvoiceIdentifier: ").append(toIndentedString(agentInvoiceIdentifier)).append("\n");
sb.append(" redirectUrl: ").append(toIndentedString(redirectUrl)).append("\n");
sb.append(" fees: ").append(toIndentedString(fees)).append("\n");
sb.append(" vendorSpecific: ").append(toIndentedString(vendorSpecific)).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 ");
}
}