travel.wink.sdk.affiliate.sales.channel.model.SalesChannelRelationshipRequestAffiliate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of affiliate-sales-channel-sdk-java Show documentation
Show all versions of affiliate-sales-channel-sdk-java Show documentation
Java SDK for the Wink Affiliate Sales Channel 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 # Sales Channel API The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. This API lets you: 1. Sales Channel: Manage existing sales channels. 2. Relationship Request: Manage relationship requests. 3. Available Supplier: Browse available suppliers to connect with. Browse the endpoints in the left navigation bar to get started.
*
* The version of the OpenAPI document: 30.5.10
* 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.affiliate.sales.channel.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.util.UUID;
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.*;
/**
* A request for relationship between two parties.
*/
@JsonPropertyOrder({
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_IDENTIFIER,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_STATUS,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_REQUEST_TYPE,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_SUPPLIER_IDENTIFIER,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_SUPPLIER_NAME,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_SUB_TYPE,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_OWNER_IDENTIFIER,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_OWNER_NAME,
SalesChannelRelationshipRequestAffiliate.JSON_PROPERTY_INTRODUCTORY_MESSAGE
})
@JsonTypeName("SalesChannelRelationshipRequest_Affiliate")
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-28T11:51:16.231644014+07:00[Asia/Bangkok]")
public class SalesChannelRelationshipRequestAffiliate {
public static final String JSON_PROPERTY_IDENTIFIER = "identifier";
private UUID identifier;
/**
* status of relationship request
*/
public enum StatusEnum {
REQUESTING("REQUESTING"),
REJECTED("REJECTED");
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;
/**
* type of relationship request
*/
public enum RequestTypeEnum {
DIRECT_CONNECTION("DIRECT_CONNECTION");
private String value;
RequestTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static RequestTypeEnum fromValue(String value) {
for (RequestTypeEnum b : RequestTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_REQUEST_TYPE = "requestType";
private RequestTypeEnum requestType;
public static final String JSON_PROPERTY_SUPPLIER_IDENTIFIER = "supplierIdentifier";
private UUID supplierIdentifier;
public static final String JSON_PROPERTY_SUPPLIER_NAME = "supplierName";
private String supplierName;
/**
* What type of segment of channel is this.
*/
public enum SubTypeEnum {
DIRECT("DIRECT"),
APPLICATION("APPLICATION"),
HOTEL("HOTEL"),
TRAVELIKO("TRAVELIKO"),
CORPORATE("CORPORATE"),
TRAVEL_AGENT("TRAVEL_AGENT"),
INFLUENCER("INFLUENCER"),
BLOGGER("BLOGGER"),
DESTINATION("DESTINATION"),
CHANNEL_MANAGER("CHANNEL_MANAGER"),
PROPERTY_MANAGEMENT_SYSTEM("PROPERTY_MANAGEMENT_SYSTEM"),
CENTRAL_RESERVATION_SYSTEM("CENTRAL_RESERVATION_SYSTEM"),
GOOGLE_HOTEL_API("GOOGLE_HOTEL_API"),
MANAGEMENT_COMPANY("MANAGEMENT_COMPANY"),
CHAIN("CHAIN"),
BRAND("BRAND"),
EVENT_ORGANIZER("EVENT_ORGANIZER");
private String value;
SubTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static SubTypeEnum fromValue(String value) {
for (SubTypeEnum b : SubTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_SUB_TYPE = "subType";
private SubTypeEnum subType;
public static final String JSON_PROPERTY_OWNER_IDENTIFIER = "ownerIdentifier";
private UUID ownerIdentifier;
public static final String JSON_PROPERTY_OWNER_NAME = "ownerName";
private String ownerName;
public static final String JSON_PROPERTY_INTRODUCTORY_MESSAGE = "introductoryMessage";
private String introductoryMessage;
public SalesChannelRelationshipRequestAffiliate() {
}
public SalesChannelRelationshipRequestAffiliate identifier(UUID identifier) {
this.identifier = identifier;
return this;
}
/**
* Unique record identifier
* @return identifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@JsonProperty(JSON_PROPERTY_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public UUID getIdentifier() {
return identifier;
}
@JsonProperty(JSON_PROPERTY_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setIdentifier(UUID identifier) {
this.identifier = identifier;
}
public SalesChannelRelationshipRequestAffiliate status(StatusEnum status) {
this.status = status;
return this;
}
/**
* status of relationship request
* @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 SalesChannelRelationshipRequestAffiliate requestType(RequestTypeEnum requestType) {
this.requestType = requestType;
return this;
}
/**
* type of relationship request
* @return requestType
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_REQUEST_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public RequestTypeEnum getRequestType() {
return requestType;
}
@JsonProperty(JSON_PROPERTY_REQUEST_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRequestType(RequestTypeEnum requestType) {
this.requestType = requestType;
}
public SalesChannelRelationshipRequestAffiliate supplierIdentifier(UUID supplierIdentifier) {
this.supplierIdentifier = supplierIdentifier;
return this;
}
/**
* Request goes to this supplier identifier.
* @return supplierIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@JsonProperty(JSON_PROPERTY_SUPPLIER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public UUID getSupplierIdentifier() {
return supplierIdentifier;
}
@JsonProperty(JSON_PROPERTY_SUPPLIER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSupplierIdentifier(UUID supplierIdentifier) {
this.supplierIdentifier = supplierIdentifier;
}
public SalesChannelRelationshipRequestAffiliate supplierName(String supplierName) {
this.supplierName = supplierName;
return this;
}
/**
* Request goes to this supplier name.
* @return supplierName
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_SUPPLIER_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSupplierName() {
return supplierName;
}
@JsonProperty(JSON_PROPERTY_SUPPLIER_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSupplierName(String supplierName) {
this.supplierName = supplierName;
}
public SalesChannelRelationshipRequestAffiliate subType(SubTypeEnum subType) {
this.subType = subType;
return this;
}
/**
* What type of segment of channel is this.
* @return subType
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_SUB_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public SubTypeEnum getSubType() {
return subType;
}
@JsonProperty(JSON_PROPERTY_SUB_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSubType(SubTypeEnum subType) {
this.subType = subType;
}
public SalesChannelRelationshipRequestAffiliate ownerIdentifier(UUID ownerIdentifier) {
this.ownerIdentifier = ownerIdentifier;
return this;
}
/**
* Specific identifier for the company / corporation / travel agency that is retrieving the rates
* @return ownerIdentifier
**/
@jakarta.annotation.Nonnull
@NotNull
@Valid
@JsonProperty(JSON_PROPERTY_OWNER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public UUID getOwnerIdentifier() {
return ownerIdentifier;
}
@JsonProperty(JSON_PROPERTY_OWNER_IDENTIFIER)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setOwnerIdentifier(UUID ownerIdentifier) {
this.ownerIdentifier = ownerIdentifier;
}
public SalesChannelRelationshipRequestAffiliate ownerName(String ownerName) {
this.ownerName = ownerName;
return this;
}
/**
* Name of the owner / affiliate.
* @return ownerName
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_OWNER_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getOwnerName() {
return ownerName;
}
@JsonProperty(JSON_PROPERTY_OWNER_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setOwnerName(String ownerName) {
this.ownerName = ownerName;
}
public SalesChannelRelationshipRequestAffiliate introductoryMessage(String introductoryMessage) {
this.introductoryMessage = introductoryMessage;
return this;
}
/**
* Owner / affiliate writes an intro to request a connection.
* @return introductoryMessage
**/
@jakarta.annotation.Nonnull
@NotNull
@JsonProperty(JSON_PROPERTY_INTRODUCTORY_MESSAGE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getIntroductoryMessage() {
return introductoryMessage;
}
@JsonProperty(JSON_PROPERTY_INTRODUCTORY_MESSAGE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setIntroductoryMessage(String introductoryMessage) {
this.introductoryMessage = introductoryMessage;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SalesChannelRelationshipRequestAffiliate salesChannelRelationshipRequestAffiliate = (SalesChannelRelationshipRequestAffiliate) o;
return Objects.equals(this.identifier, salesChannelRelationshipRequestAffiliate.identifier) &&
Objects.equals(this.status, salesChannelRelationshipRequestAffiliate.status) &&
Objects.equals(this.requestType, salesChannelRelationshipRequestAffiliate.requestType) &&
Objects.equals(this.supplierIdentifier, salesChannelRelationshipRequestAffiliate.supplierIdentifier) &&
Objects.equals(this.supplierName, salesChannelRelationshipRequestAffiliate.supplierName) &&
Objects.equals(this.subType, salesChannelRelationshipRequestAffiliate.subType) &&
Objects.equals(this.ownerIdentifier, salesChannelRelationshipRequestAffiliate.ownerIdentifier) &&
Objects.equals(this.ownerName, salesChannelRelationshipRequestAffiliate.ownerName) &&
Objects.equals(this.introductoryMessage, salesChannelRelationshipRequestAffiliate.introductoryMessage);
}
@Override
public int hashCode() {
return Objects.hash(identifier, status, requestType, supplierIdentifier, supplierName, subType, ownerIdentifier, ownerName, introductoryMessage);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SalesChannelRelationshipRequestAffiliate {\n");
sb.append(" identifier: ").append(toIndentedString(identifier)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" requestType: ").append(toIndentedString(requestType)).append("\n");
sb.append(" supplierIdentifier: ").append(toIndentedString(supplierIdentifier)).append("\n");
sb.append(" supplierName: ").append(toIndentedString(supplierName)).append("\n");
sb.append(" subType: ").append(toIndentedString(subType)).append("\n");
sb.append(" ownerIdentifier: ").append(toIndentedString(ownerIdentifier)).append("\n");
sb.append(" ownerName: ").append(toIndentedString(ownerName)).append("\n");
sb.append(" introductoryMessage: ").append(toIndentedString(introductoryMessage)).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 ");
}
}