AdditionalDataRetry.java

/*
 * Adyen Checkout API
 *
 * The version of the OpenAPI document: 72
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package com.adyen.model.checkout;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
import java.util.*;

/** AdditionalDataRetry */
@JsonPropertyOrder({
  AdditionalDataRetry.JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER,
  AdditionalDataRetry.JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER,
  AdditionalDataRetry.JSON_PROPERTY_RETRY_SKIP_RETRY
})
public class AdditionalDataRetry {
  public static final String JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER = "retry.chainAttemptNumber";
  private String retryChainAttemptNumber;

  /** Mark when the attribute has been explicitly set. */
  private boolean isSetRetryChainAttemptNumber = false;

  public static final String JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER = "retry.orderAttemptNumber";
  private String retryOrderAttemptNumber;

  /** Mark when the attribute has been explicitly set. */
  private boolean isSetRetryOrderAttemptNumber = false;

  public static final String JSON_PROPERTY_RETRY_SKIP_RETRY = "retry.skipRetry";
  private String retrySkipRetry;

  /** Mark when the attribute has been explicitly set. */
  private boolean isSetRetrySkipRetry = false;

  /**
   * Sets whether attributes with null values should be explicitly included in the JSON payload.
   * Default is false.
   */
  @JsonIgnore private boolean includeNullValues = false;

  public AdditionalDataRetry() {}

  /**
   * The number of times the transaction (not order) has been retried between different payment
   * service providers. For instance, the `chainAttemptNumber` set to 2 means that this
   * transaction has been recently tried on another provider before being sent to Adyen. > If you
   * submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   * `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retryChainAttemptNumber The number of times the transaction (not order) has been retried
   *     between different payment service providers. For instance, the
   *     `chainAttemptNumber` set to 2 means that this transaction has been recently tried
   *     on another provider before being sent to Adyen. > If you submit
   *     `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   *     `retry.skipRetry` values, we also recommend you provide the
   *     `merchantOrderReference` to facilitate linking payment attempts together.
   * @return the current {@code AdditionalDataRetry} instance, allowing for method chaining
   */
  public AdditionalDataRetry retryChainAttemptNumber(String retryChainAttemptNumber) {
    this.retryChainAttemptNumber = retryChainAttemptNumber;
    isSetRetryChainAttemptNumber = true; // mark as set
    return this;
  }

  /**
   * The number of times the transaction (not order) has been retried between different payment
   * service providers. For instance, the `chainAttemptNumber` set to 2 means that this
   * transaction has been recently tried on another provider before being sent to Adyen. > If you
   * submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   * `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @return retryChainAttemptNumber The number of times the transaction (not order) has been
   *     retried between different payment service providers. For instance, the
   *     `chainAttemptNumber` set to 2 means that this transaction has been recently tried
   *     on another provider before being sent to Adyen. > If you submit
   *     `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   *     `retry.skipRetry` values, we also recommend you provide the
   *     `merchantOrderReference` to facilitate linking payment attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public String getRetryChainAttemptNumber() {
    return retryChainAttemptNumber;
  }

  /**
   * The number of times the transaction (not order) has been retried between different payment
   * service providers. For instance, the `chainAttemptNumber` set to 2 means that this
   * transaction has been recently tried on another provider before being sent to Adyen. > If you
   * submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   * `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retryChainAttemptNumber The number of times the transaction (not order) has been retried
   *     between different payment service providers. For instance, the
   *     `chainAttemptNumber` set to 2 means that this transaction has been recently tried
   *     on another provider before being sent to Adyen. > If you submit
   *     `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and
   *     `retry.skipRetry` values, we also recommend you provide the
   *     `merchantOrderReference` to facilitate linking payment attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRetryChainAttemptNumber(String retryChainAttemptNumber) {
    this.retryChainAttemptNumber = retryChainAttemptNumber;
    isSetRetryChainAttemptNumber = true; // mark as set
  }

  /**
   * The index of the attempt to bill a particular order, which is identified by the
   * `merchantOrderReference` field. For example, if a recurring transaction fails and is
   * retried one day later, then the order number for these attempts would be 1 and 2, respectively.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retryOrderAttemptNumber The index of the attempt to bill a particular order, which is
   *     identified by the `merchantOrderReference` field. For example, if a recurring
   *     transaction fails and is retried one day later, then the order number for these attempts
   *     would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   * @return the current {@code AdditionalDataRetry} instance, allowing for method chaining
   */
  public AdditionalDataRetry retryOrderAttemptNumber(String retryOrderAttemptNumber) {
    this.retryOrderAttemptNumber = retryOrderAttemptNumber;
    isSetRetryOrderAttemptNumber = true; // mark as set
    return this;
  }

  /**
   * The index of the attempt to bill a particular order, which is identified by the
   * `merchantOrderReference` field. For example, if a recurring transaction fails and is
   * retried one day later, then the order number for these attempts would be 1 and 2, respectively.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @return retryOrderAttemptNumber The index of the attempt to bill a particular order, which is
   *     identified by the `merchantOrderReference` field. For example, if a recurring
   *     transaction fails and is retried one day later, then the order number for these attempts
   *     would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public String getRetryOrderAttemptNumber() {
    return retryOrderAttemptNumber;
  }

  /**
   * The index of the attempt to bill a particular order, which is identified by the
   * `merchantOrderReference` field. For example, if a recurring transaction fails and is
   * retried one day later, then the order number for these attempts would be 1 and 2, respectively.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retryOrderAttemptNumber The index of the attempt to bill a particular order, which is
   *     identified by the `merchantOrderReference` field. For example, if a recurring
   *     transaction fails and is retried one day later, then the order number for these attempts
   *     would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRetryOrderAttemptNumber(String retryOrderAttemptNumber) {
    this.retryOrderAttemptNumber = retryOrderAttemptNumber;
    isSetRetryOrderAttemptNumber = true; // mark as set
  }

  /**
   * The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retrySkipRetry The Boolean value indicating whether Adyen should skip or retry this
   *     transaction, if possible. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   * @return the current {@code AdditionalDataRetry} instance, allowing for method chaining
   */
  public AdditionalDataRetry retrySkipRetry(String retrySkipRetry) {
    this.retrySkipRetry = retrySkipRetry;
    isSetRetrySkipRetry = true; // mark as set
    return this;
  }

  /**
   * The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @return retrySkipRetry The Boolean value indicating whether Adyen should skip or retry this
   *     transaction, if possible. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_SKIP_RETRY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public String getRetrySkipRetry() {
    return retrySkipRetry;
  }

  /**
   * The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.
   * > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
   * and `retry.skipRetry` values, we also recommend you provide the
   * `merchantOrderReference` to facilitate linking payment attempts together.
   *
   * @param retrySkipRetry The Boolean value indicating whether Adyen should skip or retry this
   *     transaction, if possible. > If you submit `retry.chainAttemptNumber`,
   *     `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also
   *     recommend you provide the `merchantOrderReference` to facilitate linking payment
   *     attempts together.
   */
  @JsonProperty(JSON_PROPERTY_RETRY_SKIP_RETRY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRetrySkipRetry(String retrySkipRetry) {
    this.retrySkipRetry = retrySkipRetry;
    isSetRetrySkipRetry = true; // mark as set
  }

  /**
   * Configures whether null values are explicitly serialized in the JSON payload. Default is false.
   */
  public AdditionalDataRetry includeNullValues(boolean includeNullValues) {
    this.includeNullValues = includeNullValues;
    return this;
  }

  /** Returns whether null values are explicitly serialized in the JSON payload. */
  public boolean isIncludeNullValues() {
    return includeNullValues;
  }

  /**
   * Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
   */
  public void setIncludeNullValues(boolean includeNullValues) {
    this.includeNullValues = includeNullValues;
  }

  /** Return true if this AdditionalDataRetry object is equal to o. */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    AdditionalDataRetry additionalDataRetry = (AdditionalDataRetry) o;
    return Objects.equals(this.retryChainAttemptNumber, additionalDataRetry.retryChainAttemptNumber)
        && Objects.equals(
            this.isSetRetryChainAttemptNumber, additionalDataRetry.isSetRetryChainAttemptNumber)
        && Objects.equals(this.retryOrderAttemptNumber, additionalDataRetry.retryOrderAttemptNumber)
        && Objects.equals(
            this.isSetRetryOrderAttemptNumber, additionalDataRetry.isSetRetryOrderAttemptNumber)
        && Objects.equals(this.retrySkipRetry, additionalDataRetry.retrySkipRetry)
        && Objects.equals(this.isSetRetrySkipRetry, additionalDataRetry.isSetRetrySkipRetry);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        retryChainAttemptNumber,
        isSetRetryChainAttemptNumber,
        retryOrderAttemptNumber,
        isSetRetryOrderAttemptNumber,
        retrySkipRetry,
        isSetRetrySkipRetry);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class AdditionalDataRetry {\n");
    sb.append("    retryChainAttemptNumber: ")
        .append(toIndentedString(retryChainAttemptNumber))
        .append("\n");
    sb.append("    retryOrderAttemptNumber: ")
        .append(toIndentedString(retryOrderAttemptNumber))
        .append("\n");
    sb.append("    retrySkipRetry: ").append(toIndentedString(retrySkipRetry)).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    ");
  }

  /** Returns a map of properties to be merged into the JSON payload as explicit null values. */
  @JsonInclude(JsonInclude.Include.ALWAYS)
  @JsonAnyGetter
  public Map<String, Object> getExplicitNulls() {
    if (!this.includeNullValues) {
      return Collections.emptyMap();
    }

    Map<String, Object> nulls = new HashMap<>();

    if (isSetRetryChainAttemptNumber) {
      addIfNull(nulls, JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER, this.retryChainAttemptNumber);
    }
    if (isSetRetryOrderAttemptNumber) {
      addIfNull(nulls, JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER, this.retryOrderAttemptNumber);
    }
    if (isSetRetrySkipRetry) {
      addIfNull(nulls, JSON_PROPERTY_RETRY_SKIP_RETRY, this.retrySkipRetry);
    }

    return nulls;
  }

  // add to map when value is null
  private void addIfNull(Map<String, Object> map, String key, Object value) {
    if (value == null) {
      map.put(key, null);
    }
  }

  /**
   * Create an instance of AdditionalDataRetry given an JSON string
   *
   * @param jsonString JSON string
   * @return An instance of AdditionalDataRetry
   * @throws JsonProcessingException if the JSON string is invalid with respect to
   *     AdditionalDataRetry
   */
  public static AdditionalDataRetry fromJson(String jsonString) throws JsonProcessingException {
    return JSON.getMapper().readValue(jsonString, AdditionalDataRetry.class);
  }

  /**
   * Convert an instance of AdditionalDataRetry to an JSON string
   *
   * @return JSON string
   */
  public String toJson() throws JsonProcessingException {
    return JSON.getMapper().writeValueAsString(this);
  }
}