travel.wink.sdk.channel.manager.model.PageableObject Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of channel-manager-sdk-java Show documentation
Show all versions of channel-manager-sdk-java Show documentation
Java SDK for the channel manager integrators wanting to communicate with the Wink Travel Platform.
The newest version!
/*
* Wink API
* ## APIs Not every integrator needs every APIs. For that reason, we have separated APIs into context. - [Affiliate](/affiliate): All APIs related to selling travel inventory as an affiliate. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. - [Booking](/booking): All APIs related to creating platform bookings. - [Channel Manager](/channel-manager): All APIs related to channel managers who want to integrate with our platform. - [Extranet](/extranet): All APIs related to managing travel inventory and suppliers. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. - [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 with us the least. 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 # Channel Manager API Wink exposes a secured REST-based, JSON API to its channel manager partners. The connection is \"channel-wide\". Partners are free to integrate with the REST-based API using any programming language. # Intended Audience This document is intended for external channel partners who wish to integrate with Wink. # Requirements - Active account with Wink. Sign up for your Channel Manager account: - Staging: [https://staging-studio.wink.travel](https://staging-studio.wink.travel). - Production: [https://studio.wink.travel](https://studio.wink.travel). - Active application. An application provides you with Oauth2 credentials you can pass to our endpoints. One is already created for you upon account creation. - Your production IP numbers. They need to be whitelisted before you can talk to our production environment. # Performance A particular attention to performance should be given when integrating with this API. A few things to be aware of: - Enable gzip compression to make payloads smaller. - Fewer large REST calls are preferred to many small ones. E.g. It is better to update many dates instead of individual dates. - It is possible to update both rate and availability with a single request. - Request only date ranges that you will use. There is no need to request an entire year if you will only be working with the first seven days. ## Reservation notification (PUSH) Wink supports PUSH notifications to communicate reservations. We also support BASIC AUTH to your endpoint. If you want to enable PUSH, add your PUSH endpoint and credentials (optional) to your account.
*
* The version of the OpenAPI document: 30.5.13
* 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.channel.manager.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.ArrayList;
import java.util.Arrays;
import java.util.List;
import travel.wink.sdk.channel.manager.model.SortObject;
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.*;
/**
* PageableObject
*/
@JsonPropertyOrder({
PageableObject.JSON_PROPERTY_OFFSET,
PageableObject.JSON_PROPERTY_SORT,
PageableObject.JSON_PROPERTY_PAGED,
PageableObject.JSON_PROPERTY_PAGE_NUMBER,
PageableObject.JSON_PROPERTY_PAGE_SIZE,
PageableObject.JSON_PROPERTY_UNPAGED
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-04T20:21:48.540278877+07:00[Asia/Bangkok]")
public class PageableObject {
public static final String JSON_PROPERTY_OFFSET = "offset";
private Long offset;
public static final String JSON_PROPERTY_SORT = "sort";
private List sort;
public static final String JSON_PROPERTY_PAGED = "paged";
private Boolean paged;
public static final String JSON_PROPERTY_PAGE_NUMBER = "pageNumber";
private Integer pageNumber;
public static final String JSON_PROPERTY_PAGE_SIZE = "pageSize";
private Integer pageSize;
public static final String JSON_PROPERTY_UNPAGED = "unpaged";
private Boolean unpaged;
public PageableObject() {
}
public PageableObject offset(Long offset) {
this.offset = offset;
return this;
}
/**
* Get offset
* @return offset
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_OFFSET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getOffset() {
return offset;
}
@JsonProperty(JSON_PROPERTY_OFFSET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setOffset(Long offset) {
this.offset = offset;
}
public PageableObject sort(List sort) {
this.sort = sort;
return this;
}
public PageableObject addSortItem(SortObject sortItem) {
if (this.sort == null) {
this.sort = new ArrayList<>();
}
this.sort.add(sortItem);
return this;
}
/**
* Get sort
* @return sort
**/
@jakarta.annotation.Nullable
@Valid
@JsonProperty(JSON_PROPERTY_SORT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getSort() {
return sort;
}
@JsonProperty(JSON_PROPERTY_SORT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSort(List sort) {
this.sort = sort;
}
public PageableObject paged(Boolean paged) {
this.paged = paged;
return this;
}
/**
* Get paged
* @return paged
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PAGED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getPaged() {
return paged;
}
@JsonProperty(JSON_PROPERTY_PAGED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPaged(Boolean paged) {
this.paged = paged;
}
public PageableObject pageNumber(Integer pageNumber) {
this.pageNumber = pageNumber;
return this;
}
/**
* Get pageNumber
* @return pageNumber
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PAGE_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getPageNumber() {
return pageNumber;
}
@JsonProperty(JSON_PROPERTY_PAGE_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPageNumber(Integer pageNumber) {
this.pageNumber = pageNumber;
}
public PageableObject pageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Get pageSize
* @return pageSize
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PAGE_SIZE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getPageSize() {
return pageSize;
}
@JsonProperty(JSON_PROPERTY_PAGE_SIZE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPageSize(Integer pageSize) {
this.pageSize = pageSize;
}
public PageableObject unpaged(Boolean unpaged) {
this.unpaged = unpaged;
return this;
}
/**
* Get unpaged
* @return unpaged
**/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_UNPAGED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getUnpaged() {
return unpaged;
}
@JsonProperty(JSON_PROPERTY_UNPAGED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUnpaged(Boolean unpaged) {
this.unpaged = unpaged;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PageableObject pageableObject = (PageableObject) o;
return Objects.equals(this.offset, pageableObject.offset) &&
Objects.equals(this.sort, pageableObject.sort) &&
Objects.equals(this.paged, pageableObject.paged) &&
Objects.equals(this.pageNumber, pageableObject.pageNumber) &&
Objects.equals(this.pageSize, pageableObject.pageSize) &&
Objects.equals(this.unpaged, pageableObject.unpaged);
}
@Override
public int hashCode() {
return Objects.hash(offset, sort, paged, pageNumber, pageSize, unpaged);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PageableObject {\n");
sb.append(" offset: ").append(toIndentedString(offset)).append("\n");
sb.append(" sort: ").append(toIndentedString(sort)).append("\n");
sb.append(" paged: ").append(toIndentedString(paged)).append("\n");
sb.append(" pageNumber: ").append(toIndentedString(pageNumber)).append("\n");
sb.append(" pageSize: ").append(toIndentedString(pageSize)).append("\n");
sb.append(" unpaged: ").append(toIndentedString(unpaged)).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 ");
}
}