uk.org.openbanking.datamodel.account.OBOffer1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbanking-sdk Show documentation
Show all versions of openbanking-sdk Show documentation
A Java SDK to help implementing the Open Banking standard : https://www.openbanking.org.uk/read-write-apis/
/**
*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at https://forgerock.org/cddlv1-0/. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2019 ForgeRock AS.
*/
package uk.org.openbanking.datamodel.account;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiModelProperty;
import org.joda.time.DateTime;
import org.springframework.validation.annotation.Validated;
import uk.org.openbanking.datamodel.payment.OBActiveOrHistoricCurrencyAndAmount;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.util.Objects;
/**
* OBOffer1
*/
@Validated
@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2018-10-01T11:26:57.876+01:00")
public class OBOffer1 {
@JsonProperty("AccountId")
private String accountId = null;
@JsonProperty("OfferId")
private String offerId = null;
@JsonProperty("OfferType")
private OBExternalOfferType1Code offerType = null;
@JsonProperty("Description")
private String description = null;
@JsonProperty("StartDateTime")
private DateTime startDateTime = null;
@JsonProperty("EndDateTime")
private DateTime endDateTime = null;
@JsonProperty("Rate")
private String rate = null;
@JsonProperty("Value")
private Integer value = null;
@JsonProperty("Term")
private String term = null;
@JsonProperty("URL")
private String URL = null;
@JsonProperty("Amount")
private OBActiveOrHistoricCurrencyAndAmount amount = null;
@JsonProperty("Fee")
private OBActiveOrHistoricCurrencyAndAmount fee = null;
public OBOffer1 accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* Get accountId
* @return accountId
**/
@ApiModelProperty(required = true, value = "")
@NotNull
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public OBOffer1 offerId(String offerId) {
this.offerId = offerId;
return this;
}
/**
* A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.
* @return offerId
**/
@ApiModelProperty(value = "A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.")
@Size(min=1,max=40)
public String getOfferId() {
return offerId;
}
public void setOfferId(String offerId) {
this.offerId = offerId;
}
public OBOffer1 offerType(OBExternalOfferType1Code offerType) {
this.offerType = offerType;
return this;
}
/**
* Get offerType
* @return offerType
**/
@ApiModelProperty(value = "")
@Valid
public OBExternalOfferType1Code getOfferType() {
return offerType;
}
public void setOfferType(OBExternalOfferType1Code offerType) {
this.offerType = offerType;
}
public OBOffer1 description(String description) {
this.description = description;
return this;
}
/**
* Further details of the offer.
* @return description
**/
@ApiModelProperty(value = "Further details of the offer.")
@Size(min=1,max=500)
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public OBOffer1 startDateTime(DateTime startDateTime) {
this.startDateTime = startDateTime;
return this;
}
/**
* Date and time at which the offer starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
* @return startDateTime
**/
@ApiModelProperty(value = "Date and time at which the offer starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00")
@Valid
public DateTime getStartDateTime() {
return startDateTime;
}
public void setStartDateTime(DateTime startDateTime) {
this.startDateTime = startDateTime;
}
public OBOffer1 endDateTime(DateTime endDateTime) {
this.endDateTime = endDateTime;
return this;
}
/**
* Date and time at which the offer ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
* @return endDateTime
**/
@ApiModelProperty(value = "Date and time at which the offer ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00")
@Valid
public DateTime getEndDateTime() {
return endDateTime;
}
public void setEndDateTime(DateTime endDateTime) {
this.endDateTime = endDateTime;
}
public OBOffer1 rate(String rate) {
this.rate = rate;
return this;
}
/**
* Rate associated with the offer type.
* @return rate
**/
@ApiModelProperty(value = "Rate associated with the offer type.")
@Pattern(regexp="^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$") @Size(min=1,max=10)
public String getRate() {
return rate;
}
public void setRate(String rate) {
this.rate = rate;
}
public OBOffer1 value(Integer value) {
this.value = value;
return this;
}
/**
* Value associated with the offer type.
* @return value
**/
@ApiModelProperty(value = "Value associated with the offer type.")
public Integer getValue() {
return value;
}
public void setValue(Integer value) {
this.value = value;
}
public OBOffer1 term(String term) {
this.term = term;
return this;
}
/**
* Further details of the term of the offer.
* @return term
**/
@ApiModelProperty(value = "Further details of the term of the offer.")
@Size(min=1,max=500)
public String getTerm() {
return term;
}
public void setTerm(String term) {
this.term = term;
}
public OBOffer1 URL(String URL) {
this.URL = URL;
return this;
}
/**
* URL (Uniform Resource Locator) where documentation on the offer can be found
* @return URL
**/
@ApiModelProperty(value = "URL (Uniform Resource Locator) where documentation on the offer can be found")
@Size(min=1,max=256)
public String getURL() {
return URL;
}
public void setURL(String URL) {
this.URL = URL;
}
public OBOffer1 amount(OBActiveOrHistoricCurrencyAndAmount amount) {
this.amount = amount;
return this;
}
/**
* Get amount
* @return amount
**/
@ApiModelProperty(value = "")
@Valid
public OBActiveOrHistoricCurrencyAndAmount getAmount() {
return amount;
}
public void setAmount(OBActiveOrHistoricCurrencyAndAmount amount) {
this.amount = amount;
}
public OBOffer1 fee(OBActiveOrHistoricCurrencyAndAmount fee) {
this.fee = fee;
return this;
}
/**
* Get fee
* @return fee
**/
@ApiModelProperty(value = "")
@Valid
public OBActiveOrHistoricCurrencyAndAmount getFee() {
return fee;
}
public void setFee(OBActiveOrHistoricCurrencyAndAmount fee) {
this.fee = fee;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OBOffer1 obOffer1 = (OBOffer1) o;
return Objects.equals(this.accountId, obOffer1.accountId) &&
Objects.equals(this.offerId, obOffer1.offerId) &&
Objects.equals(this.offerType, obOffer1.offerType) &&
Objects.equals(this.description, obOffer1.description) &&
Objects.equals(this.startDateTime, obOffer1.startDateTime) &&
Objects.equals(this.endDateTime, obOffer1.endDateTime) &&
Objects.equals(this.rate, obOffer1.rate) &&
Objects.equals(this.value, obOffer1.value) &&
Objects.equals(this.term, obOffer1.term) &&
Objects.equals(this.URL, obOffer1.URL) &&
Objects.equals(this.amount, obOffer1.amount) &&
Objects.equals(this.fee, obOffer1.fee);
}
@Override
public int hashCode() {
return Objects.hash(accountId, offerId, offerType, description, startDateTime, endDateTime, rate, value, term, URL, amount, fee);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OBOffer1 {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" offerId: ").append(toIndentedString(offerId)).append("\n");
sb.append(" offerType: ").append(toIndentedString(offerType)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" startDateTime: ").append(toIndentedString(startDateTime)).append("\n");
sb.append(" endDateTime: ").append(toIndentedString(endDateTime)).append("\n");
sb.append(" rate: ").append(toIndentedString(rate)).append("\n");
sb.append(" value: ").append(toIndentedString(value)).append("\n");
sb.append(" term: ").append(toIndentedString(term)).append("\n");
sb.append(" URL: ").append(toIndentedString(URL)).append("\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" fee: ").append(toIndentedString(fee)).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(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}