<?php

namespace Razorpay\Api;

use Requests;

/**
 * Invoice entity gets used for both Payment Links and Invoices system.
 * Few of the methods are only meaningful for Invoices system and calling those
 * for against/for a Payment Link would throw Bad request error.
 */
class Invoice extends Entity
{
    /**
     * Creates invoice of any type(invoice|link|ecod).
     *
     * @param array $attributes
     *
     * @return Invoice
     */
    public function create($attributes = array())
    {
        return parent::create($attributes);
    }

    /**
     * Fetches invoice entity with given id
     *
     * @param string $id
     *
     * @return Invoice
     */
    public function fetch($id)
    {
        return parent::fetch($id);
    }

    /**
     * Fetches multiple invoices with given query options
     *
     * @param array $options
     *
     * @return Collection
     */
    public function all($options = array())
    {
        return parent::all($options);
    }

    /**
     * Cancels issued invoice
     *
     * @return Invoice
     */
    public function cancel()
    {
        $url = $this->getEntityUrl() . $this->id . '/cancel';

        return $this->request(Requests::POST, $url);
    }

    /**
     * Send/re-send notification for invoice by given medium
     *
     * @param $medium - sms|email
     *
     * @return array
     */
    public function notifyBy($medium)
    {
        $url = $this->getEntityUrl() . $this->id . '/notify_by/' . $medium;

        return (new Request())->request(Requests::POST, $url);
    }

    /**
     * Patches given invoice with new attributes
     *
     * @param array $attributes
     *
     * @return Invoice
     */
    public function edit($attributes = array())
    {
        $url = $this->getEntityUrl() . $this->id;

        return $this->request(Requests::PATCH, $url, $attributes);
    }

    /**
     * Issues drafted invoice
     *
     * @return Invoice
     */
    public function issue()
    {
        $url = $this->getEntityUrl() . $this->id . '/issue';

        return $this->request(Requests::POST, $url);
    }

    /**
     * Deletes drafted invoice
     *
     * @return Invoice
     */
    public function delete()
    {
        $url = $this->getEntityUrl() . $this->id;

        return (new Request())->request(Requests::DELETE, $url);
    }
}