dev.vality.swag.payments.model.PaymentParams 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.Payer;
import dev.vality.swag.payments.model.PaymentFlow;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

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

  @JsonProperty("flow")
  private PaymentFlow flow = null;

  @JsonProperty("payer")
  private Payer payer = null;

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

  @JsonProperty("makeRecurrent")
  private Boolean makeRecurrent = false;

  @JsonProperty("metadata")
  private Object metadata = null;

  public PaymentParams 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 PaymentParams flow(PaymentFlow flow) {
    this.flow = flow;
    return this;
  }

   /**
   * Get flow
   * @return flow
  **/
  @ApiModelProperty(required = true, value = "")
  public PaymentFlow getFlow() {
    return flow;
  }

  public void setFlow(PaymentFlow flow) {
    this.flow = flow;
  }

  public PaymentParams payer(Payer payer) {
    this.payer = payer;
    return this;
  }

   /**
   * Get payer
   * @return payer
  **/
  @ApiModelProperty(required = true, value = "")
  public Payer getPayer() {
    return payer;
  }

  public void setPayer(Payer payer) {
    this.payer = payer;
  }

  public PaymentParams processingDeadline(String processingDeadline) {
    this.processingDeadline = processingDeadline;
    return this;
  }

   /**
   * Максимальное время обработки платежа
   * @return processingDeadline
  **/
  @ApiModelProperty(example = "30m", value = "Максимальное время обработки платежа")
  public String getProcessingDeadline() {
    return processingDeadline;
  }

  public void setProcessingDeadline(String processingDeadline) {
    this.processingDeadline = processingDeadline;
  }

  public PaymentParams makeRecurrent(Boolean makeRecurrent) {
    this.makeRecurrent = makeRecurrent;
    return this;
  }

   /**
   * Признак создания родительского рекуррентного платежа. Успешно проведеный платеж с этим признаком можно использовать как родительский в других рекуррентных платежах. 
   * @return makeRecurrent
  **/
  @ApiModelProperty(value = "Признак создания родительского рекуррентного платежа. Успешно проведеный платеж с этим признаком можно использовать как родительский в других рекуррентных платежах. ")
  public Boolean isMakeRecurrent() {
    return makeRecurrent;
  }

  public void setMakeRecurrent(Boolean makeRecurrent) {
    this.makeRecurrent = makeRecurrent;
  }

  public PaymentParams metadata(Object metadata) {
    this.metadata = metadata;
    return this;
  }

   /**
   * Метаданные, которые необходимо связать с платежом
   * @return metadata
  **/
  @ApiModelProperty(value = "Метаданные, которые необходимо связать с платежом")
  public Object getMetadata() {
    return metadata;
  }

  public void setMetadata(Object metadata) {
    this.metadata = metadata;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    PaymentParams paymentParams = (PaymentParams) o;
    return Objects.equals(this.externalID, paymentParams.externalID) &&
        Objects.equals(this.flow, paymentParams.flow) &&
        Objects.equals(this.payer, paymentParams.payer) &&
        Objects.equals(this.processingDeadline, paymentParams.processingDeadline) &&
        Objects.equals(this.makeRecurrent, paymentParams.makeRecurrent) &&
        Objects.equals(this.metadata, paymentParams.metadata);
  }

  @Override
  public int hashCode() {
    return Objects.hash(externalID, flow, payer, processingDeadline, makeRecurrent, metadata);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class PaymentParams {\n");
    
    sb.append("    externalID: ").append(toIndentedString(externalID)).append("\n");
    sb.append("    flow: ").append(toIndentedString(flow)).append("\n");
    sb.append("    payer: ").append(toIndentedString(payer)).append("\n");
    sb.append("    processingDeadline: ").append(toIndentedString(processingDeadline)).append("\n");
    sb.append("    makeRecurrent: ").append(toIndentedString(makeRecurrent)).append("\n");
    sb.append("    metadata: ").append(toIndentedString(metadata)).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    ");
  }

}