<?php

declare(strict_types=1);

namespace Square\Legacy\Models;

/**
 * Indicates the status of a [gift card]($m/GiftCard) redemption. This status is relevant only for
 * redemptions made from Square products (such as Square Point of Sale) because Square\Legacy products use a
 * two-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED`
 * status.
 */
class GiftCardActivityRedeemStatus
{
    /**
     * The gift card redemption is pending. `PENDING` is a temporary status that applies when a
     * gift card is redeemed from Square Point of Sale or another Square product. A `PENDING` status is
     * updated to
     * `COMPLETED` if the payment is captured or `CANCELED` if the authorization is voided.
     */
    public const PENDING = 'PENDING';

    /**
     * The gift card redemption is completed.
     */
    public const COMPLETED = 'COMPLETED';

    /**
     * The gift card redemption is canceled. A redemption is canceled if the authorization
     * on the gift card is voided.
     */
    public const CANCELED = 'CANCELED';
}
