<?php

namespace Mollie\Api\Resources;

use Mollie\Api\Types\RefundStatus;
class Refund extends \Mollie\Api\Resources\BaseResource
{
    use HasPresetOptions;
    /**
     * Id of the payment method.
     *
     * @var string
     */
    public $id;
    /**
     * Mode of the refund, either "live" or "test".
     *
     * @var string
     */
    public $mode;
    /**
     * The $amount that was refunded.
     *
     * @var \stdClass
     */
    public $amount;
    /**
     * UTC datetime the payment was created in ISO-8601 format.
     *
     * @example "2013-12-25T10:30:54+00:00"
     * @var string
     */
    public $createdAt;
    /**
     * The refund's description, if available.
     *
     * @var string|null
     */
    public $description;
    /**
     * The payment id that was refunded.
     *
     * @var string
     */
    public $paymentId;
    /**
     * The order id that was refunded.
     *
     * @var string|null
     */
    public $orderId;
    /**
     * The order lines contain the actual things the customer ordered.
     * The lines will show the quantity, discountAmount, vatAmount and totalAmount
     * refunded.
     *
     * @var array|object[]|null
     */
    public $lines;
    /**
     * The settlement amount
     *
     * @var \stdClass
     */
    public $settlementAmount;
    /**
     * The refund status
     *
     * @var string
     */
    public $status;
    /**
     * @var \stdClass
     */
    public $_links;
    /**
     * An object containing information relevant to a refund issued for a split payment.
     *
     * @var array|object[]|null
     */
    public $routingReversal;
    /**
     * @var \stdClass|null
     */
    public $metadata;
    /**
     * @return bool
     */
    public function canBeCanceled()
    {
        return $this->isQueued() || $this->isPending();
    }
    /**
     * Is this refund queued?
     *
     * @return bool
     */
    public function isQueued()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_QUEUED;
    }
    /**
     * Is this refund pending?
     *
     * @return bool
     */
    public function isPending()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_PENDING;
    }
    /**
     * Is this refund processing?
     *
     * @return bool
     */
    public function isProcessing()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_PROCESSING;
    }
    /**
     * Is this refund transferred to consumer?
     *
     * @return bool
     */
    public function isTransferred()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_REFUNDED;
    }
    /**
     * Is this refund failed?
     *
     * @return bool
     */
    public function isFailed()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_FAILED;
    }
    /**
     * Is this refund canceled?
     *
     * @return bool
     */
    public function isCanceled()
    {
        return $this->status === \Mollie\Api\Types\RefundStatus::STATUS_CANCELED;
    }
    /**
     * Cancel the refund.
     * Returns null if successful.
     *
     * @return null
     * @throws \Mollie\Api\Exceptions\ApiException
     */
    public function cancel()
    {
        return $this->client->paymentRefunds->cancelForId($this->paymentId, $this->id, $this->getPresetOptions());
    }
}