meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Refunds\RefundsRequestBuilder

Namespace: \YooKassa\Request\Refunds

---

Summary:

Класс билдера объектов запросов к API списка возвратов

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
protected	$currentObject		Инстанс собираемого запроса

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
public	build()		Собирает и возвращает объект запроса списка возвратов магазина
public	setCreatedAtGt()		Устанавливает дату создания от которой выбираются возвраты
public	setCreatedAtGte()		Устанавливает дату создания от которой выбираются возвраты
public	setCreatedAtLt()		Устанавливает дату создания до которой выбираются возвраты
public	setCreatedAtLte()		Устанавливает дату создания до которой выбираются возвраты
public	setCursor()		Устанавливает токен следующей страницы выборки
public	setLimit()		Устанавливает ограничение количества объектов возвратов
public	setOptions()		Устанавливает свойства запроса из массива
public	setPaymentId()		Устанавливает идентификатор платежа или null, если требуется его удалить
public	setStatus()		Устанавливает статус выбираемых возвратов
protected	initCurrentObject()		Инициализирует новый инстанс собираемого объекта

---

Details

• File: lib/Request/Refunds/RefundsRequestBuilder.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\Refunds\RefundsRequestBuilder

---

Properties

protected $currentObject : \YooKassa\Request\Refunds\RefundsRequest

---

Summary

Инстанс собираемого запроса

Type: RefundsRequest Инстанс собираемого объекта запроса Details:

---

Methods

public __construct() : mixed

public __construct() : mixed

Summary

Конструктор, инициализирует пустой запрос, который в будущем начнём собирать

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Returns: mixed -

public build() : \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest

public build(array|null $options = null) : \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest

Summary

Собирает и возвращает объект запроса списка возвратов магазина

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
array OR null	options	Массив с настройками запроса

Returns: \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса к API для получения списка возвратов магазина

public setCreatedAtGt() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setCreatedAtGt(\DateTime|string|int|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает дату создания от которой выбираются возвраты

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (не включая) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtGte() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setCreatedAtGte(\DateTime|string|int|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает дату создания от которой выбираются возвраты

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (включительно) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtLt() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setCreatedAtLt(\DateTime|string|int|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает дату создания до которой выбираются возвраты

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (не включая) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtLte() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setCreatedAtLte(\DateTime|string|int|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает дату создания до которой выбираются возвраты

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (включительно) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setCursor() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setCursor(string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает токен следующей страницы выборки

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
string	value	Токен следующей страницы выборки или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setLimit() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setLimit(string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает ограничение количества объектов возвратов

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
string	value	Ограничение количества объектов возвратов или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод было передана не целое число

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего билдера

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

Устанавливает свойства запроса из массива

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Parameters:

Type	Name	Description
array OR \Traversable	options	Массив свойств запроса

Throws:

Type	Description
\InvalidArgumentException	Выбрасывается если аргумент не массив и не итерируемый объект
\YooKassa\Common\Exceptions\InvalidPropertyException	Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек

Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов

public setPaymentId() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setPaymentId(string|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает идентификатор платежа или null, если требуется его удалить

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Идентификатор платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если длина переданной строки не равна 36 символам
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

public setStatus() : \YooKassa\Request\Refunds\RefundsRequestBuilder

public setStatus(string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder

Summary

Устанавливает статус выбираемых возвратов

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Parameters:

Type	Name	Description
string	value	Статус выбираемых платежей или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера

protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequest

protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequest

Summary

Инициализирует новый инстанс собираемого объекта

Details:

• Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder

Returns: \YooKassa\Request\Refunds\RefundsRequest - Инстанс собираемого запроса

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney