mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-19 01:50:19 +00:00
Антон Н. Николаев
532 lines
22 KiB
PHP
532 lines
22 KiB
PHP
<?php
|
||
|
||
/*
|
||
* The MIT License
|
||
*
|
||
* Copyright (c) 2024 "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\Request\Refunds;
|
||
|
||
use DateTime;
|
||
use Exception;
|
||
use YooKassa\Common\AbstractRequest;
|
||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||
use YooKassa\Helpers\TypeCast;
|
||
use YooKassa\Model\Refund\RefundStatus;
|
||
|
||
/**
|
||
* Класс, представляющий модель RefundsRequest.
|
||
*
|
||
* Класс объекта запроса к API списка возвратов магазина.
|
||
*
|
||
* @category Class
|
||
* @package YooKassa\Request
|
||
* @author cms@yoomoney.ru
|
||
* @link https://yookassa.ru/developers/api
|
||
*
|
||
* @property DateTime $createdAtGte Время создания, от (включительно)
|
||
* @property DateTime $createdAtGt Время создания, от (не включая)
|
||
* @property DateTime $createdAtLte Время создания, до (включительно)
|
||
* @property DateTime $createdAtLt Время создания, до (не включая)
|
||
* @property string $paymentId Идентификатор платежа
|
||
* @property string $status Статус возврата
|
||
* @property null|int $limit Ограничение количества объектов возврата, отображаемых на одной странице выдачи
|
||
* @property string $cursor Токен для получения следующей страницы выборки
|
||
*/
|
||
class RefundsRequest extends AbstractRequest implements RefundsRequestInterface
|
||
{
|
||
/** Максимальное количество объектов возвратов в выборке */
|
||
public const MAX_LIMIT_VALUE = 100;
|
||
|
||
/**
|
||
* @var DateTime|null Время создания, от (включительно)
|
||
*/
|
||
private ?DateTime $_createdAtGte = null;
|
||
|
||
/**
|
||
* @var DateTime|null Время создания, от (не включая)
|
||
*/
|
||
private ?DateTime $_createdAtGt = null;
|
||
|
||
/**
|
||
* @var DateTime|null Время создания, до (включительно)
|
||
*/
|
||
private ?DateTime $_createdAtLte = null;
|
||
|
||
/**
|
||
* @var DateTime|null Время создания, до (не включая)
|
||
*/
|
||
private ?DateTime $_createdAtLt = null;
|
||
|
||
/**
|
||
* @var string|null Идентификатор шлюза
|
||
*/
|
||
private ?string $_paymentId = null;
|
||
|
||
/**
|
||
* @var string|null Статус возврата
|
||
*/
|
||
private ?string $_status = null;
|
||
|
||
/**
|
||
* @var int|null Ограничение количества объектов платежа
|
||
*/
|
||
private ?int $_limit = null;
|
||
|
||
/**
|
||
* @var string|null Токен для получения следующей страницы выборки
|
||
*/
|
||
private ?string $_cursor = null;
|
||
|
||
/**
|
||
* Возвращает идентификатор платежа если он задан или null.
|
||
*
|
||
* @return null|string Идентификатор платежа
|
||
*/
|
||
public function getPaymentId(): ?string
|
||
{
|
||
return $this->_paymentId;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, был ли задан идентификатор платежа.
|
||
*
|
||
* @return bool True если идентификатор был задан, false если нет
|
||
*/
|
||
public function hasPaymentId(): bool
|
||
{
|
||
return !empty($this->_paymentId);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает идентификатор платежа или null, если требуется его удалить.
|
||
*
|
||
* @param null|string $value Идентификатор платежа
|
||
*
|
||
* @throws InvalidPropertyValueException Выбрасывается если длина переданной строки не равна 36 символам
|
||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||
*/
|
||
public function setPaymentId(?string $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_paymentId = null;
|
||
} elseif (TypeCast::canCastToString($value)) {
|
||
$length = mb_strlen((string) $value, 'utf-8');
|
||
if (36 != $length) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid payment id value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.paymentId',
|
||
$value
|
||
);
|
||
}
|
||
$this->_paymentId = (string) $value;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid payment id value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.paymentId',
|
||
$value
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена.
|
||
*
|
||
* @return null|DateTime Время создания, от (включительно)
|
||
*/
|
||
public function getCreatedAtGte(): ?DateTime
|
||
{
|
||
return $this->_createdAtGte;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, была ли установлена дата создания от которой выбираются возвраты.
|
||
*
|
||
* @return bool True если дата была установлена, false если нет
|
||
*/
|
||
public function hasCreatedAtGte(): bool
|
||
{
|
||
return !empty($this->_createdAtGte);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает дату создания от которой выбираются возвраты.
|
||
*
|
||
* @param null|DateTime|int|string $value Время создания, от (включительно) или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||
* @throws Exception|InvalidPropertyValueTypeException Генерируется если была передана дата с не тем типом (передана не
|
||
* строка, не число и не значение типа DateTime)
|
||
*/
|
||
public function setCreatedAtGte(mixed $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_createdAtGte = null;
|
||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||
$dateTime = TypeCast::castToDateTime($value);
|
||
if (null === $dateTime) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid created_gte value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdAtGte'
|
||
);
|
||
}
|
||
$this->_createdAtGte = $dateTime;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid created_gte value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdAtGte'
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена.
|
||
*
|
||
* @return null|DateTime Время создания, от (не включая)
|
||
*/
|
||
public function getCreatedAtGt(): ?DateTime
|
||
{
|
||
return $this->_createdAtGt;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, была ли установлена дата создания от которой выбираются возвраты.
|
||
*
|
||
* @return bool True если дата была установлена, false если нет
|
||
*/
|
||
public function hasCreatedAtGt(): bool
|
||
{
|
||
return !empty($this->_createdAtGt);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает дату создания от которой выбираются возвраты.
|
||
*
|
||
* @param null|DateTime|int|string $value Время создания, от (не включая) или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||
* @throws Exception|InvalidPropertyValueTypeException Генерируется если была передана дата с не тем типом (передана не
|
||
* строка, не число и не значение типа DateTime)
|
||
*/
|
||
public function setCreatedAtGt(mixed $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_createdAtGt = null;
|
||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||
$dateTime = TypeCast::castToDateTime($value);
|
||
if (null === $dateTime) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid created_gt value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdAtGt'
|
||
);
|
||
}
|
||
$this->_createdAtGt = $dateTime;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid created_gt value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdAtGt'
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена.
|
||
*
|
||
* @return null|DateTime Время создания, до (включительно)
|
||
*/
|
||
public function getCreatedAtLte(): ?DateTime
|
||
{
|
||
return $this->_createdAtLte;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, была ли установлена дата создания до которой выбираются возвраты.
|
||
*
|
||
* @return bool True если дата была установлена, false если нет
|
||
*/
|
||
public function hasCreatedAtLte(): bool
|
||
{
|
||
return !empty($this->_createdAtLte);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает дату создания до которой выбираются возвраты.
|
||
*
|
||
* @param null|DateTime|int|string $value Время создания, до (включительно) или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||
* @throws Exception|InvalidPropertyValueTypeException Генерируется если была передана дата с не тем типом (передана не
|
||
* строка, не число и не значение типа DateTime)
|
||
*/
|
||
public function setCreatedAtLte(mixed $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_createdAtLte = null;
|
||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||
$dateTime = TypeCast::castToDateTime($value);
|
||
if (null === $dateTime) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid created_lte value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdLte'
|
||
);
|
||
}
|
||
$this->_createdAtLte = $dateTime;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid created_lte value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdLte'
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена.
|
||
*
|
||
* @return null|DateTime Время создания, до (не включая)
|
||
*/
|
||
public function getCreatedAtLt(): ?DateTime
|
||
{
|
||
return $this->_createdAtLt;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, была ли установлена дата создания до которой выбираются возвраты.
|
||
*
|
||
* @return bool True если дата была установлена, false если нет
|
||
*/
|
||
public function hasCreatedAtLt(): bool
|
||
{
|
||
return !empty($this->_createdAtLt);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает дату создания до которой выбираются возвраты.
|
||
*
|
||
* @param null|DateTime|int|string $value Время создания, до (не включая) или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||
* @throws Exception|InvalidPropertyValueTypeException Генерируется если была передана дата с не тем типом (передана не
|
||
* строка, не число и не значение типа DateTime)
|
||
*/
|
||
public function setCreatedAtLt(mixed $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_createdAtLt = null;
|
||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||
$dateTime = TypeCast::castToDateTime($value);
|
||
if (null === $dateTime) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid created_lt value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdLt'
|
||
);
|
||
}
|
||
$this->_createdAtLt = $dateTime;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid created_lt value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.createdLt'
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает статус выбираемых возвратов или null, если он до этого не был установлен.
|
||
*
|
||
* @return null|string Статус выбираемых возвратов
|
||
*/
|
||
public function getStatus(): ?string
|
||
{
|
||
return $this->_status;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, был ли установлен статус выбираемых возвратов.
|
||
*
|
||
* @return bool True если статус был установлен, false если нет
|
||
*/
|
||
public function hasStatus(): bool
|
||
{
|
||
return !empty($this->_status);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает статус выбираемых возвратов.
|
||
*
|
||
* @param string|null $value Статус выбираемых платежей или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение не является валидным статусом
|
||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||
*/
|
||
public function setStatus(?string $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_status = null;
|
||
} elseif (TypeCast::canCastToEnumString($value)) {
|
||
if (!RefundStatus::valueExists((string) $value)) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid status value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.status',
|
||
$value
|
||
);
|
||
}
|
||
$this->_status = $value;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid status value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.status',
|
||
$value
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Возвращает токен для получения следующей страницы выборки.
|
||
*
|
||
* @return null|string Токен для получения следующей страницы выборки
|
||
*/
|
||
public function getCursor(): ?string
|
||
{
|
||
return $this->_cursor;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, был ли установлен токен следующей страницы.
|
||
*
|
||
* @return bool True если токен был установлен, false если нет
|
||
*/
|
||
public function hasCursor(): bool
|
||
{
|
||
return !empty($this->_cursor);
|
||
}
|
||
|
||
/**
|
||
* Устанавливает токен следующей страницы выборки.
|
||
*
|
||
* @param string|null $value Токен следующей страницы выборки или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||
*/
|
||
public function setCursor(?string $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_cursor = null;
|
||
} elseif (TypeCast::canCastToString($value)) {
|
||
$this->_cursor = (string) $value;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid status value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.cursor',
|
||
$value
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Ограничение количества объектов платежа.
|
||
*
|
||
* @return null|int Ограничение количества объектов платежа
|
||
*/
|
||
public function getLimit(): ?int
|
||
{
|
||
return $this->_limit;
|
||
}
|
||
|
||
/**
|
||
* Проверяет, было ли установлено ограничение количества объектов платежа.
|
||
*
|
||
* @return bool True если было установлено, false если нет
|
||
*/
|
||
public function hasLimit(): bool
|
||
{
|
||
return null !== $this->_limit;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает ограничение количества объектов платежа.
|
||
*
|
||
* @param null|int|string $value Ограничение количества объектов платежа или null, чтобы удалить значение
|
||
*
|
||
* @throws InvalidPropertyValueTypeException Выбрасывается, если в метод было передано не целое число
|
||
*/
|
||
public function setLimit(mixed $value): void
|
||
{
|
||
if (null === $value || '' === $value) {
|
||
$this->_limit = null;
|
||
} elseif (is_int($value)) {
|
||
if ($value < 0 || $value > self::MAX_LIMIT_VALUE) {
|
||
throw new InvalidPropertyValueException(
|
||
'Invalid limit value in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.limit',
|
||
$value
|
||
);
|
||
}
|
||
$this->_limit = $value;
|
||
} else {
|
||
throw new InvalidPropertyValueTypeException(
|
||
'Invalid limit value type in RefundsRequest',
|
||
0,
|
||
'RefundsRequest.limit',
|
||
$value
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Проверяет валидность текущего объекта запроса.
|
||
*
|
||
* @return bool True если объект валиден, false если нет
|
||
*/
|
||
public function validate(): bool
|
||
{
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Возвращает инстанс билдера объектов запросов списка возвратов магазина.
|
||
*
|
||
* @return RefundsRequestBuilder Билдер объектов запросов списка возвратов
|
||
*/
|
||
public static function builder(): RefundsRequestBuilder
|
||
{
|
||
return new RefundsRequestBuilder();
|
||
}
|
||
}
|