com.squareup.square.models.PayOrderRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square Show documentation
Java client library for the Square API
There is a newer version: 41.2.0.20241017

package com.squareup.square.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
import java.util.List;
import java.util.Objects;

/**
 * This is a model class for PayOrderRequest type.
 */
public class PayOrderRequest {
    private final String idempotencyKey;
    private final OptionalNullable orderVersion;
    private final OptionalNullable> paymentIds;

    /**
     * Initialization constructor.
     * @param  idempotencyKey  String value for idempotencyKey.
     * @param  orderVersion  Integer value for orderVersion.
     * @param  paymentIds  List of String value for paymentIds.
     */
    @JsonCreator
    public PayOrderRequest(
            @JsonProperty("idempotency_key") String idempotencyKey,
            @JsonProperty("order_version") Integer orderVersion,
            @JsonProperty("payment_ids") List paymentIds) {
        this.idempotencyKey = idempotencyKey;
        this.orderVersion = OptionalNullable.of(orderVersion);
        this.paymentIds = OptionalNullable.of(paymentIds);
    }

    /**
     * Initialization constructor.
     * @param  idempotencyKey  String value for idempotencyKey.
     * @param  orderVersion  Integer value for orderVersion.
     * @param  paymentIds  List of String value for paymentIds.
     */

    protected PayOrderRequest(String idempotencyKey, OptionalNullable orderVersion,
            OptionalNullable> paymentIds) {
        this.idempotencyKey = idempotencyKey;
        this.orderVersion = orderVersion;
        this.paymentIds = paymentIds;
    }

    /**
     * Getter for IdempotencyKey.
     * A value you specify that uniquely identifies this request among requests you have sent. If
     * you are unsure whether a particular payment request was completed successfully, you can
     * reattempt it with the same idempotency key without worrying about duplicate payments. For
     * more information, see
     * [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
     * @return Returns the String
     */
    @JsonGetter("idempotency_key")
    public String getIdempotencyKey() {
        return idempotencyKey;
    }

    /**
     * Internal Getter for OrderVersion.
     * The version of the order being paid. If not supplied, the latest version will be paid.
     * @return Returns the Internal Integer
     */
    @JsonGetter("order_version")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonSerialize(using = OptionalNullable.Serializer.class)
    protected OptionalNullable internalGetOrderVersion() {
        return this.orderVersion;
    }

    /**
     * Getter for OrderVersion.
     * The version of the order being paid. If not supplied, the latest version will be paid.
     * @return Returns the Integer
     */
    @JsonIgnore
    public Integer getOrderVersion() {
        return OptionalNullable.getFrom(orderVersion);
    }

    /**
     * Internal Getter for PaymentIds.
     * The IDs of the [payments](entity:Payment) to collect. The payment total must match the order
     * total.
     * @return Returns the Internal List of String
     */
    @JsonGetter("payment_ids")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @JsonSerialize(using = OptionalNullable.Serializer.class)
    protected OptionalNullable> internalGetPaymentIds() {
        return this.paymentIds;
    }

    /**
     * Getter for PaymentIds.
     * The IDs of the [payments](entity:Payment) to collect. The payment total must match the order
     * total.
     * @return Returns the List of String
     */
    @JsonIgnore
    public List getPaymentIds() {
        return OptionalNullable.getFrom(paymentIds);
    }

    @Override
    public int hashCode() {
        return Objects.hash(idempotencyKey, orderVersion, paymentIds);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof PayOrderRequest)) {
            return false;
        }
        PayOrderRequest other = (PayOrderRequest) obj;
        return Objects.equals(idempotencyKey, other.idempotencyKey)
            && Objects.equals(orderVersion, other.orderVersion)
            && Objects.equals(paymentIds, other.paymentIds);
    }

    /**
     * Converts this PayOrderRequest into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "PayOrderRequest [" + "idempotencyKey=" + idempotencyKey + ", orderVersion="
                + orderVersion + ", paymentIds=" + paymentIds + "]";
    }

    /**
     * Builds a new {@link PayOrderRequest.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link PayOrderRequest.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder(idempotencyKey);
        builder.orderVersion = internalGetOrderVersion();
        builder.paymentIds = internalGetPaymentIds();
        return builder;
    }

    /**
     * Class to build instances of {@link PayOrderRequest}.
     */
    public static class Builder {
        private String idempotencyKey;
        private OptionalNullable orderVersion;
        private OptionalNullable> paymentIds;

        /**
         * Initialization constructor.
         * @param  idempotencyKey  String value for idempotencyKey.
         */
        public Builder(String idempotencyKey) {
            this.idempotencyKey = idempotencyKey;
        }

        /**
         * Setter for idempotencyKey.
         * @param  idempotencyKey  String value for idempotencyKey.
         * @return Builder
         */
        public Builder idempotencyKey(String idempotencyKey) {
            this.idempotencyKey = idempotencyKey;
            return this;
        }

        /**
         * Setter for orderVersion.
         * @param  orderVersion  Integer value for orderVersion.
         * @return Builder
         */
        public Builder orderVersion(Integer orderVersion) {
            this.orderVersion = OptionalNullable.of(orderVersion);
            return this;
        }

        /**
         * UnSetter for orderVersion.
         * @return Builder
         */
        public Builder unsetOrderVersion() {
            orderVersion = null;
            return this;
        }

        /**
         * Setter for paymentIds.
         * @param  paymentIds  List of String value for paymentIds.
         * @return Builder
         */
        public Builder paymentIds(List paymentIds) {
            this.paymentIds = OptionalNullable.of(paymentIds);
            return this;
        }

        /**
         * UnSetter for paymentIds.
         * @return Builder
         */
        public Builder unsetPaymentIds() {
            paymentIds = null;
            return this;
        }

        /**
         * Builds a new {@link PayOrderRequest} object using the set fields.
         * @return {@link PayOrderRequest}
         */
        public PayOrderRequest build() {
            return new PayOrderRequest(idempotencyKey, orderVersion, paymentIds);
        }
    }
}