dev.vality.swag.payments.model.CaptureParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swag-payments Show documentation
There is a newer version: 1.650-5dc6d9f-server
/*
 * 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.Reason;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;

/**
 * CaptureParams
 */
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2022-08-22T08:18:24.176Z")
public class CaptureParams {
  @JsonProperty("reason")
  private String reason = null;

  @JsonProperty("amount")
  private Long amount = null;

  @JsonProperty("currency")
  private String currency = null;

  @JsonProperty("cart")
  private List cart = null;

  @JsonProperty("allocation")
  private List allocation = null;

  public CaptureParams reason(String reason) {
    this.reason = reason;
    return this;
  }

   /**
   * Причина совершения операции
   * @return reason
  **/
  @ApiModelProperty(required = true, value = "Причина совершения операции")
  public String getReason() {
    return reason;
  }

  public void setReason(String reason) {
    this.reason = reason;
  }

  public CaptureParams amount(Long amount) {
    this.amount = amount;
    return this;
  }

   /**
   * Подтверждаемая сумма платежа, в минорных денежных единицах, например в копейках в случае указания российских рублей в качестве валюты. 
   * minimum: 1
   * @return amount
  **/
  @ApiModelProperty(value = "Подтверждаемая сумма платежа, в минорных денежных единицах, например в копейках в случае указания российских рублей в качестве валюты. ")
  public Long getAmount() {
    return amount;
  }

  public void setAmount(Long amount) {
    this.amount = amount;
  }

  public CaptureParams currency(String currency) {
    this.currency = currency;
    return this;
  }

   /**
   * Валюта, символьный код согласно [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
   * @return currency
  **/
  @ApiModelProperty(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 CaptureParams cart(List cart) {
    this.cart = cart;
    return this;
  }

  public CaptureParams 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 CaptureParams allocation(List allocation) {
    this.allocation = allocation;
    return this;
  }

  public CaptureParams 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;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CaptureParams captureParams = (CaptureParams) o;
    return Objects.equals(this.reason, captureParams.reason) &&
        Objects.equals(this.amount, captureParams.amount) &&
        Objects.equals(this.currency, captureParams.currency) &&
        Objects.equals(this.cart, captureParams.cart) &&
        Objects.equals(this.allocation, captureParams.allocation);
  }

  @Override
  public int hashCode() {
    return Objects.hash(reason, amount, currency, cart, allocation);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CaptureParams {\n");
    
    sb.append("    reason: ").append(toIndentedString(reason)).append("\n");
    sb.append("    amount: ").append(toIndentedString(amount)).append("\n");
    sb.append("    currency: ").append(toIndentedString(currency)).append("\n");
    sb.append("    cart: ").append(toIndentedString(cart)).append("\n");
    sb.append("    allocation: ").append(toIndentedString(allocation)).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    ");
  }

}