io.sphere.sdk.payments.commands.updateactions.SetAuthorization Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation

sphere-models

There is a newer version: 1.0.0-M26

package io.sphere.sdk.payments.commands.updateactions;

import io.sphere.sdk.commands.UpdateActionImpl;
import io.sphere.sdk.payments.Payment;

import javax.annotation.Nullable;
import javax.money.MonetaryAmount;
import java.time.ZonedDateTime;

/**
 * Sets the amount of money that has been authorized and optionally until when the authorization is valid. If no amount is provided, the authorization is unset.
 *
 * {@doc.gen intro}
 *
 * {@include.example io.sphere.sdk.payments.commands.PaymentUpdateCommandTest#setAuthorization()}
 *
 * @see Payment
 *
 *
 */
public final class SetAuthorization extends UpdateActionImpl {
    @Nullable
    private final MonetaryAmount amount;
    @Nullable
    private final ZonedDateTime until;

    private SetAuthorization(@Nullable final MonetaryAmount amount, @Nullable final ZonedDateTime until) {
        super("setAuthorization");
        this.amount = amount;
        this.until = until;
    }

    public static SetAuthorization of(@Nullable final MonetaryAmount amount) {
        return of(amount, null);
    }

    public static SetAuthorization of(@Nullable final MonetaryAmount amount, @Nullable final ZonedDateTime until) {
        return new SetAuthorization(amount, until);
    }

    @Nullable
    public MonetaryAmount getAmount() {
        return amount;
    }

    @Nullable
    public ZonedDateTime getUntil() {
        return until;
    }

    public static SetAuthorization ofRemove() {
        return of(null, null);
    }
}