77 lines
2.5 KiB
PHP
77 lines
2.5 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
/**
|
|
* Integrates BTCPay Server with Magento 2 for online payments
|
|
* Copyright (C) 2019 Storefront BVBA
|
|
*
|
|
* This file is part of Storefront/BTCPay.
|
|
*
|
|
* Storefront/BTCPay is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace Storefront\BTCPay\Api;
|
|
|
|
use Magento\Framework\Api\SearchCriteriaInterface;
|
|
|
|
interface InvoiceRepositoryInterface
|
|
{
|
|
|
|
/**
|
|
* Save Invoice
|
|
* @param \Storefront\BTCPay\Api\Data\InvoiceInterface $invoice
|
|
* @return \Storefront\BTCPay\Api\Data\InvoiceInterface
|
|
* @throws \Magento\Framework\Exception\LocalizedException
|
|
*/
|
|
public function save(
|
|
\Storefront\BTCPay\Api\Data\InvoiceInterface $invoice
|
|
);
|
|
|
|
/**
|
|
* Retrieve Invoice
|
|
* @param string $invoiceId
|
|
* @return \Storefront\BTCPay\Api\Data\InvoiceInterface
|
|
* @throws \Magento\Framework\Exception\LocalizedException
|
|
*/
|
|
public function getById($invoiceId);
|
|
|
|
/**
|
|
* Retrieve Invoice matching the specified criteria.
|
|
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
|
|
* @return \Storefront\BTCPay\Api\Data\InvoiceSearchResultsInterface
|
|
* @throws \Magento\Framework\Exception\LocalizedException
|
|
*/
|
|
public function getList(
|
|
\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
|
|
);
|
|
|
|
/**
|
|
* Delete Invoice
|
|
* @param \Storefront\BTCPay\Api\Data\InvoiceInterface $invoice
|
|
* @return bool true on success
|
|
* @throws \Magento\Framework\Exception\LocalizedException
|
|
*/
|
|
public function delete(
|
|
\Storefront\BTCPay\Api\Data\InvoiceInterface $invoice
|
|
);
|
|
|
|
/**
|
|
* Delete Invoice by ID
|
|
* @param string $invoiceId
|
|
* @return bool true on success
|
|
* @throws \Magento\Framework\Exception\NoSuchEntityException
|
|
* @throws \Magento\Framework\Exception\LocalizedException
|
|
*/
|
|
public function deleteById($invoiceId);
|
|
}
|