dev.vality.swag.payments.model.RefundSearchResult Maven / Gradle / Ivy
/*
* Vality Payments API
* ## Описание Vality Payments API предназначен для мерчантов, принимающих платежи из своего пользовательского интерфейса, например веб-сайта или мобильного приложения, и является единственной точкой взаимодействия с системой для проведения операций оплаты товаров и услуг. ## Детали взаимодействия При любом обращении к API в заголовке `X-Request-ID` соответствующего запроса необходимо передать его уникальный идентификатор: ``` X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9 ``` ### Тип содержимого и кодировка Система принимает и возвращает данные в формате JSON и кодировке UTF-8: ``` Content-Type: application/json; charset=utf-8 ``` ### Формат дат Система принимает и возвращает значения отметок времени в формате `date-time`, описанном в [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339): ``` 2017-01-01T00:00:00Z 2017-01-01T00:00:01+00:00 ``` ### Максимальное время обработки запроса При любом обращении к API в заголовке `X-Request-Deadline` соответствующего запроса можно передать параметр отсечки по времени, определяющий максимальное время ожидания завершения операции по запросу: ``` X-Request-Deadline: 10s ``` По истечении указанного времени система прекращает обработку запроса. Рекомендуется указывать значение не более одной минуты, но не менее трёх секунд. `X-Request-Deadline` может: * задаваться в формате `date-time` согласно [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339); * задаваться в относительных величинах: в миллисекундах (`150000ms`), секундах (`540s`) или минутах (`3.5m`).
*
* OpenAPI spec version: 2.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package dev.vality.swag.payments.model;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import dev.vality.swag.payments.model.AllocationTransaction;
import dev.vality.swag.payments.model.InvoiceLine;
import dev.vality.swag.payments.model.Refund;
import dev.vality.swag.payments.model.RefundError;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
/**
* RefundSearchResult
*/
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2022-08-22T08:18:24.176Z")
public class RefundSearchResult {
@JsonProperty("id")
private String id = null;
@JsonProperty("externalID")
private String externalID = null;
@JsonProperty("createdAt")
private OffsetDateTime createdAt = null;
@JsonProperty("amount")
private Long amount = null;
@JsonProperty("currency")
private String currency = null;
@JsonProperty("reason")
private String reason = null;
@JsonProperty("cart")
private List cart = null;
@JsonProperty("allocation")
private List allocation = null;
/**
* Статус возврата
*/
public enum StatusEnum {
PENDING("pending"),
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 text) {
for (StatusEnum b : StatusEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
}
@JsonProperty("status")
private StatusEnum status = null;
@JsonProperty("error")
private RefundError error = null;
@JsonProperty("invoiceID")
private String invoiceID = null;
@JsonProperty("paymentID")
private String paymentID = null;
public RefundSearchResult id(String id) {
this.id = id;
return this;
}
/**
* Идентификатор возврата
* @return id
**/
@ApiModelProperty(required = true, value = "Идентификатор возврата")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public RefundSearchResult externalID(String externalID) {
this.externalID = externalID;
return this;
}
/**
* Уникальный в рамках платформы идентификатор сущности для данного участника. Используется для обеспечения идемпотентности запроса.
* @return externalID
**/
@ApiModelProperty(value = "Уникальный в рамках платформы идентификатор сущности для данного участника. Используется для обеспечения идемпотентности запроса. ")
public String getExternalID() {
return externalID;
}
public void setExternalID(String externalID) {
this.externalID = externalID;
}
public RefundSearchResult createdAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Дата и время осуществления
* @return createdAt
**/
@ApiModelProperty(required = true, value = "Дата и время осуществления")
public OffsetDateTime getCreatedAt() {
return createdAt;
}
public void setCreatedAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
}
public RefundSearchResult amount(Long amount) {
this.amount = amount;
return this;
}
/**
* Сумма возврата, в минорных денежных единицах, например в копейках в случае указания российских рублей в качестве валюты.
* minimum: 1
* @return amount
**/
@ApiModelProperty(required = true, value = "Сумма возврата, в минорных денежных единицах, например в копейках в случае указания российских рублей в качестве валюты. ")
public Long getAmount() {
return amount;
}
public void setAmount(Long amount) {
this.amount = amount;
}
public RefundSearchResult currency(String currency) {
this.currency = currency;
return this;
}
/**
* Валюта, символьный код согласно [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
* @return currency
**/
@ApiModelProperty(required = true, value = "Валюта, символьный код согласно [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).")
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public RefundSearchResult reason(String reason) {
this.reason = reason;
return this;
}
/**
* Причина осуществления возврата
* @return reason
**/
@ApiModelProperty(value = "Причина осуществления возврата")
public String getReason() {
return reason;
}
public void setReason(String reason) {
this.reason = reason;
}
public RefundSearchResult cart(List cart) {
this.cart = cart;
return this;
}
public RefundSearchResult addCartItem(InvoiceLine cartItem) {
if (this.cart == null) {
this.cart = new ArrayList<>();
}
this.cart.add(cartItem);
return this;
}
/**
* Итоговая корзина предоставляемых товаров и услуг, которая должна формироваться из корзины инвойса исключением позиций, по которым производился возврат. Сумма корзины должна совпадать с суммой платежа за вычетом суммы возврата.
* @return cart
**/
@ApiModelProperty(value = "Итоговая корзина предоставляемых товаров и услуг, которая должна формироваться из корзины инвойса исключением позиций, по которым производился возврат. Сумма корзины должна совпадать с суммой платежа за вычетом суммы возврата. ")
public List getCart() {
return cart;
}
public void setCart(List cart) {
this.cart = cart;
}
public RefundSearchResult allocation(List allocation) {
this.allocation = allocation;
return this;
}
public RefundSearchResult addAllocationItem(AllocationTransaction allocationItem) {
if (this.allocation == null) {
this.allocation = new ArrayList<>();
}
this.allocation.add(allocationItem);
return this;
}
/**
* Итоговое распределение денежных средств, которое должно формироваться из распределения инвойса исключением позиций, по которым производится возврат.
* @return allocation
**/
@ApiModelProperty(value = "Итоговое распределение денежных средств, которое должно формироваться из распределения инвойса исключением позиций, по которым производится возврат. ")
public List getAllocation() {
return allocation;
}
public void setAllocation(List allocation) {
this.allocation = allocation;
}
public RefundSearchResult status(StatusEnum status) {
this.status = status;
return this;
}
/**
* Статус возврата
* @return status
**/
@ApiModelProperty(required = true, value = "Статус возврата")
public StatusEnum getStatus() {
return status;
}
public void setStatus(StatusEnum status) {
this.status = status;
}
public RefundSearchResult error(RefundError error) {
this.error = error;
return this;
}
/**
* Get error
* @return error
**/
@ApiModelProperty(value = "")
public RefundError getError() {
return error;
}
public void setError(RefundError error) {
this.error = error;
}
public RefundSearchResult invoiceID(String invoiceID) {
this.invoiceID = invoiceID;
return this;
}
/**
* Идентификатор инвойса
* @return invoiceID
**/
@ApiModelProperty(required = true, value = "Идентификатор инвойса")
public String getInvoiceID() {
return invoiceID;
}
public void setInvoiceID(String invoiceID) {
this.invoiceID = invoiceID;
}
public RefundSearchResult paymentID(String paymentID) {
this.paymentID = paymentID;
return this;
}
/**
* Идентификатор платежа
* @return paymentID
**/
@ApiModelProperty(required = true, value = "Идентификатор платежа")
public String getPaymentID() {
return paymentID;
}
public void setPaymentID(String paymentID) {
this.paymentID = paymentID;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
RefundSearchResult refundSearchResult = (RefundSearchResult) o;
return Objects.equals(this.id, refundSearchResult.id) &&
Objects.equals(this.externalID, refundSearchResult.externalID) &&
Objects.equals(this.createdAt, refundSearchResult.createdAt) &&
Objects.equals(this.amount, refundSearchResult.amount) &&
Objects.equals(this.currency, refundSearchResult.currency) &&
Objects.equals(this.reason, refundSearchResult.reason) &&
Objects.equals(this.cart, refundSearchResult.cart) &&
Objects.equals(this.allocation, refundSearchResult.allocation) &&
Objects.equals(this.status, refundSearchResult.status) &&
Objects.equals(this.error, refundSearchResult.error) &&
Objects.equals(this.invoiceID, refundSearchResult.invoiceID) &&
Objects.equals(this.paymentID, refundSearchResult.paymentID);
}
@Override
public int hashCode() {
return Objects.hash(id, externalID, createdAt, amount, currency, reason, cart, allocation, status, error, invoiceID, paymentID);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RefundSearchResult {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" externalID: ").append(toIndentedString(externalID)).append("\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" reason: ").append(toIndentedString(reason)).append("\n");
sb.append(" cart: ").append(toIndentedString(cart)).append("\n");
sb.append(" allocation: ").append(toIndentedString(allocation)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" error: ").append(toIndentedString(error)).append("\n");
sb.append(" invoiceID: ").append(toIndentedString(invoiceID)).append("\n");
sb.append(" paymentID: ").append(toIndentedString(paymentID)).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 ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy