63 lines
2.7 KiB
PHP
63 lines
2.7 KiB
PHP
|
<?php
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* The MIT License
|
|||
|
|
*
|
|||
|
|
* Copyright (c) 2023 "YooMoney", NBСO LLC
|
|||
|
|
*
|
|||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|||
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|||
|
|
* in the Software without restriction, including without limitation the rights
|
|||
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|||
|
|
* furnished to do so, subject to the following conditions:
|
|||
|
|
*
|
|||
|
|
* The above copyright notice and this permission notice shall be included in
|
|||
|
|
* all copies or substantial portions of the Software.
|
|||
|
|
*
|
|||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|||
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|||
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|||
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|||
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|||
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|||
|
|
* THE SOFTWARE.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
namespace YooKassa\Model\Notification;
|
|||
|
|
|
|||
|
|
use YooKassa\Model\PaymentInterface;
|
|||
|
|
use YooKassa\Model\RefundInterface;
|
|||
|
|
|
|||
|
|
interface NotificationInterface
|
|||
|
|
{
|
|||
|
|
/**
|
|||
|
|
* Возвращает тип уведомления
|
|||
|
|
*
|
|||
|
|
* Тип уведомления - одна из констант, указанных в перечислении {@link NotificationType}.
|
|||
|
|
*
|
|||
|
|
* @return string Тип уведомления в виде строки
|
|||
|
|
*/
|
|||
|
|
public function getType();
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Возвращает тип события
|
|||
|
|
*
|
|||
|
|
* Тип события - одна из констант, указанных в перечислении {@link NotificationEventType}.
|
|||
|
|
*
|
|||
|
|
* @return string Тип события
|
|||
|
|
*/
|
|||
|
|
public function getEvent();
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте
|
|||
|
|
*
|
|||
|
|
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
|
|||
|
|
* получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о
|
|||
|
|
* платеже у API.
|
|||
|
|
*
|
|||
|
|
* @return PaymentInterface|RefundInterface Объект с информацией о платеже
|
|||
|
|
*/
|
|||
|
|
public function getObject();
|
|||
|
|
}
|