diff --git a/.gitignore b/.gitignore index a26d59ba..59c462c7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ /vendor/ .idea +.phpdoc composer.lock /build/ phpunit.xml diff --git a/CHANGELOG.md b/CHANGELOG.md index fac48b52..5d0027d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,14 @@ +### v2.8.0 от 06.04.2023 +* Добавлена работа с персональными данными +* Добавлено получение списка банков участников СБП +* Добавлена работа с самозанятыми +* Добавлена информация для проверки операций на мошенничество +* Изменения по выплатам +* Поправки в документации +* Изменен год в копирайте на 2023 +* Добавлены анализаторы кода +* Исправлены некоторые ошибки + ### v2.7.7 от 09.03.2023 * Добавлен idempotenceKey в документацию * Добавлен метод для установки дополнительных параметров curl diff --git a/LICENSE.md b/LICENSE.md index e8ccd33a..7fe38365 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ The MIT License -Copyright (c) 2022 "YooMoney", NBСO LLC +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 diff --git a/README.en.md b/README.en.md index 0dc77db6..41f06ed9 100644 --- a/README.en.md +++ b/README.en.md @@ -69,6 +69,7 @@ $client->setAuth('shopId', 'secretKey'); ## Examples of using the API SDK #### [YooKassa SDK Settings](docs/examples/01-configuration.md) +* [Additional settings for Curl](docs/examples/01-configuration.md#Установка-дополнительных-настроек-для-Curl) * [Authentication](docs/examples/01-configuration.md#Аутентификация) * [Statistics about the environment used](docs/examples/01-configuration.md#Статистические-данные-об-используемом-окружении) * [Getting information about the store](docs/examples/01-configuration.md#Получение-информации-о-магазине) @@ -99,7 +100,16 @@ $client->setAuth('shopId', 'secretKey'); * [Request to create a deal](docs/examples/05-deals.md#Запрос-на-создание-сделки) * [Request to create a deal via the builder](docs/examples/05-deals.md#Запрос-на-создание-сделки-через-билдер) * [Request to create a payment with info about deal](docs/examples/05-deals.md#Запрос-на-создание-платежа-с-привязкой-к-сделке) -* [Request to create a payout](docs/examples/05-deals.md#Запрос-на-выплату-продавцу) * [Get deal information](docs/examples/05-deals.md#Получить-информацию-о-сделке) * [Get a list of deals with filtering](docs/examples/05-deals.md#Получить-список-сделок-с-фильтрацией) -* [Get payout information](docs/examples/05-deals.md#Получить-информацию-о-выплате) + +#### [Working with payouts](docs/examples/06-payouts.md) +* [Request to create a payout](docs/examples/06-payouts.md#Запрос-на-выплату-продавцу) +* [Get payout information](docs/examples/06-payouts.md#Получить-информацию-о-выплате) + +#### [Working with personal data](docs/examples/08-personal-data.md) +* [Creation of personal data](docs/examples/08-personal-data.md#Создание-персональных-данных) +* [Get information about personal data](docs/examples/08-personal-data.md#Получить-информацию-о-персональных-данных) + +#### [Working with the list of SBP participants](docs/examples/09-sbp-banks.md) +* [Get a list of SBP participants](docs/examples/09-sbp-banks.md#Получить-список-участников-СБП) diff --git a/README.md b/README.md index 832d09c7..933c6a7a 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ $client->setAuth('shopId', 'secretKey'); ## Примеры использования SDK #### [Настройки SDK API ЮKassa](docs/examples/01-configuration.md) +* [Установка дополнительных настроек для Curl](docs/examples/01-configuration.md#Установка-дополнительных-настроек-для-Curl) * [Аутентификация](docs/examples/01-configuration.md#Аутентификация) * [Статистические данные об используемом окружении](docs/examples/01-configuration.md#Статистические-данные-об-используемом-окружении) * [Получение информации о магазине](docs/examples/01-configuration.md#Получение-информации-о-магазине) @@ -101,7 +102,16 @@ $client->setAuth('shopId', 'secretKey'); * [Запрос на создание сделки](docs/examples/05-deals.md#Запрос-на-создание-сделки) * [Запрос на создание сделки через билдер](docs/examples/05-deals.md#Запрос-на-создание-сделки-через-билдер) * [Запрос на создание платежа с привязкой к сделке](docs/examples/05-deals.md#Запрос-на-создание-платежа-с-привязкой-к-сделке) -* [Запрос на выплату продавцу](docs/examples/05-deals.md#Запрос-на-выплату-продавцу) * [Получить информацию о сделке](docs/examples/05-deals.md#Получить-информацию-о-сделке) * [Получить список сделок с фильтрацией](docs/examples/05-deals.md#Получить-список-сделок-с-фильтрацией) -* [Получить информацию о выплате](docs/examples/05-deals.md#Получить-информацию-о-выплате) + +#### [Работа с выплатами](docs/examples/06-payouts.md) +* [Запрос на выплату продавцу](docs/examples/06-payouts.md#Запрос-на-выплату-продавцу) +* [Получить информацию о выплате](docs/examples/06-payouts.md#Получить-информацию-о-выплате) + +#### [Работа с персональными данными](docs/examples/08-personal-data.md) +* [Создание персональных данных](docs/examples/08-personal-data.md#Создание-персональных-данных) +* [Получить информацию о персональных данных](docs/examples/08-personal-data.md#Получить-информацию-о-персональных-данных) + +#### [Работа со списком участников СБП](docs/examples/09-sbp-banks.md) +* [Получить список участников СБП](docs/examples/09-sbp-banks.md#Получить-список-участников-СБП) diff --git a/composer.json b/composer.json index 838cca35..730f430e 100644 --- a/composer.json +++ b/composer.json @@ -13,9 +13,9 @@ ], "dist": { "type": "zip", - "url": "https://git.yoomoney.ru/rest/api/latest/projects/SDK/repos/yookassa-sdk-php/archive?at=refs%2Ftags%2F2.7.7&format=zip" + "url": "https://git.yoomoney.ru/rest/api/latest/projects/SDK/repos/yookassa-sdk-php/archive?at=refs%2Ftags%2F2.8.0&format=zip" }, - "version": "2.7.7", + "version": "2.8.0", "require": { "php": ">=5.3.0", "ext-curl": "*", @@ -26,7 +26,11 @@ "require-dev": { "ext-xml": "*", "phpunit/phpunit": "^4.8.35 || ^5.7", - "mockery/mockery": "^0.9.9" + "mockery/mockery": "^0.9.9", + "php-parallel-lint/php-parallel-lint": "^1.0", + "phpmd/phpmd": "^2.13", + "squizlabs/php_codesniffer": "*", + "phpstan/phpstan": "^1.10" }, "scripts": { "test": [ @@ -41,11 +45,11 @@ "@phpcs", "@phpmd" ], - "phplint": "vendor/bin/parallel-lint --exclude vendor/ --exclude .idea/ -e php,module,inc,install,profile,theme .", + "phplint": "vendor/bin/parallel-lint --exclude vendor/ --exclude .idea/ --exclude tests/ -e php .", "phpunit": "vendor/bin/phpunit --configuration=phpunit.xml.dist", - "phpcs": "vendor/bin/phpcs --ignore=vendor/,.idea/ --standard=phpcs.xml --extensions=php,module,inc,install,profile,theme,css,info,txt,md,yml --report=full .", - "phpcbf": "vendor/bin/phpcbf --ignore=vendor/,.idea/ --standard=phpcs.xml --extensions=php,module,inc,install,profile,theme,css,info,txt,md,yml .", - "phpmd": "vendor/bin/phpmd --exclude vendor/,.idea/ --suffixes php,module,inc,install,profile,theme . text phpmd.xml" + "phpcs": "vendor/bin/phpcs --ignore=vendor/,.idea/,tests/ --standard=phpcs.xml --extensions=php --report=full .", + "phpcbf": "vendor/bin/phpcbf --ignore=vendor/,.idea/,tests/ --standard=phpcs.xml --extensions=php .", + "phpmd": "vendor/bin/phpmd --exclude vendor/,.idea/,tests/ --suffixes php . text phpmd.xml" }, "autoload": { "psr-4": { diff --git a/docs/classes/JsonSerializable.md b/docs/classes/JsonSerializable.md index 843c72dd..ed6ebd37 100644 --- a/docs/classes/JsonSerializable.md +++ b/docs/classes/JsonSerializable.md @@ -16,7 +16,7 @@ --- ### Details * File: [lib/Common/legacy_json_serializable.php](../../lib/Common/legacy_json_serializable.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -45,11 +45,11 @@ public jsonSerialize() : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-ApiClientInterface.md b/docs/classes/YooKassa-Client-ApiClientInterface.md index 8d7606b6..3bc5f270 100644 --- a/docs/classes/YooKassa-Client-ApiClientInterface.md +++ b/docs/classes/YooKassa-Client-ApiClientInterface.md @@ -213,11 +213,11 @@ public setAdvancedCurlOptions() : void ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-BaseClient.md b/docs/classes/YooKassa-Client-BaseClient.md index 85b43b73..67d62c8d 100644 --- a/docs/classes/YooKassa-Client-BaseClient.md +++ b/docs/classes/YooKassa-Client-BaseClient.md @@ -15,6 +15,9 @@ | public | [RECEIPTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_RECEIPTS_PATH) | | Точка входа для запросов к API по чекам | | public | [DEALS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_DEALS_PATH) | | Точка входа для запросов к API по сделкам | | public | [PAYOUTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYOUTS_PATH) | | Точка входа для запросов к API по выплатам | +| public | [PERSONAL_DATA_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PERSONAL_DATA_PATH) | | Точка входа для запросов к API по персональным данным | +| public | [SBP_BANKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SBP_BANKS_PATH) | | Точка входа для запросов к API по участникам СБП | +| public | [SELF_EMPLOYED_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SELF_EMPLOYED_PATH) | | Точка входа для запросов к API по самозанятым | | public | [IDEMPOTENCY_KEY_HEADER](../classes/YooKassa-Client-BaseClient.md#constant_IDEMPOTENCY_KEY_HEADER) | | Имя HTTP заголовка, используемого для передачи idempotence key | | public | [DEFAULT_DELAY](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_DELAY) | | Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 | | public | [DEFAULT_TRIES_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_TRIES_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | @@ -56,7 +59,7 @@ --- ### Details * File: [lib/Client/BaseClient.php](../../lib/Client/BaseClient.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Client\BaseClient @@ -125,6 +128,33 @@ PAYOUTS_PATH = '/payouts' ``` + +###### PERSONAL_DATA_PATH +Точка входа для запросов к API по персональным данным + +```php +PERSONAL_DATA_PATH = '/personal_data' +``` + + + +###### SBP_BANKS_PATH +Точка входа для запросов к API по участникам СБП + +```php +SBP_BANKS_PATH = '/sbp_banks' +``` + + + +###### SELF_EMPLOYED_PATH +Точка входа для запросов к API по самозанятым + +```php +SELF_EMPLOYED_PATH = '/self_employed' +``` + + ###### IDEMPOTENCY_KEY_HEADER Имя HTTP заголовка, используемого для передачи idempotence key @@ -171,7 +201,7 @@ DEFAULT_ATTEMPTS_COUNT = 3 CURL клиент -**Type:** ApiClientInterface +**Type:** ApiClientInterface **Details:** @@ -187,7 +217,7 @@ CURL клиент Значение по умолчанию 3 -**Type:** int +**Type:** int **Details:** @@ -199,7 +229,7 @@ CURL клиент Настройки для CURL клиента -**Type:** array +**Type:** array **Details:** @@ -211,7 +241,7 @@ CURL клиент Объект для логирования работы SDK -**Type:** LoggerInterface|null +**Type:** LoggerInterface|null **Details:** @@ -223,7 +253,7 @@ CURL клиент shopId магазина -**Type:** string|int +**Type:** string|int **Details:** @@ -235,7 +265,7 @@ shopId магазина Секретный ключ магазина -**Type:** string +**Type:** string **Details:** @@ -251,7 +281,7 @@ shopId магазина Значение по умолчанию - 1800 миллисекунд. -**Type:** int +**Type:** int Значение в миллисекундах **Details:** @@ -333,12 +363,12 @@ public isNotificationIPTrusted(string $ip) : bool ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | ip | - IPv4 или IPv6 адрес webhook уведомления | +| string | ip | IPv4 или IPv6 адрес webhook уведомления | ##### Throws: | Type | Description | | ---- | ----------- | -| \Exception | - исключение будет выброшено, если будет передан IP адрес неверного формата | +| \Exception | Выбрасывается, если будет передан IP адрес неверного формата | **Returns:** bool - @@ -387,10 +417,9 @@ public setAuth(string $login, string $password) : $this **Returns:** $this - ##### Examples: -Пример авторизации: +01-client.php 7 1 Пример авторизации: ```php -$client->setAuth('xxxxxx', 'test_XXXXXXX'); ``` @@ -416,10 +445,9 @@ public setAuthToken(string $token) : $this **Returns:** $this - ##### Examples: -Пример авторизации: +01-client.php 9 1 Пример авторизации: ```php -$client->setAuthToken('token_XXXXXXX'); ``` @@ -529,9 +557,9 @@ protected decodeData(\YooKassa\Common\ResponseObject $response) : array ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Common\ResponseObject | response | | +| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API | -**Returns:** array - +**Returns:** array - Массив данных @@ -551,7 +579,7 @@ protected delay(\YooKassa\Common\ResponseObject $response) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Common\ResponseObject | response | | +| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API | **Returns:** mixed - @@ -573,21 +601,21 @@ protected encodeData(array $serializedData) : string ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array | serializedData | | +| array | serializedData | Массив данных для кодировки | ##### Throws: | Type | Description | | ---- | ----------- | -| \Exception | | +| \Exception | Выбрасывается, если не удалось конвертировать данные в строку JSON | -**Returns:** string - +**Returns:** string - Строка JSON #### protected execute() : mixed|\YooKassa\Common\ResponseObject ```php -protected execute(string $path, string $method, array $queryParams, null $httpBody = null, array $headers = array()) : mixed|\YooKassa\Common\ResponseObject +protected execute(string $path, string $method, array $queryParams, string|null $httpBody = null, array $headers = array()) : mixed|\YooKassa\Common\ResponseObject ``` **Summary** @@ -600,11 +628,11 @@ protected execute(string $path, string $method, array $queryParams, null $httpBo ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | path | | -| string | method | | -| array | queryParams | | -| null | httpBody | | -| array | headers | | +| string | path | URL запроса | +| string | method | HTTP метод | +| array | queryParams | Массив GET параметров запроса | +| string OR null | httpBody | Тело запроса | +| array | headers | Массив заголовков запроса | ##### Throws: | Type | Description | @@ -639,14 +667,15 @@ protected handleError(\YooKassa\Common\ResponseObject $response) : mixed ##### Throws: | Type | Description | | ---- | ----------- | -| \YooKassa\Common\Exceptions\ApiException | | -| \YooKassa\Common\Exceptions\BadApiRequestException | | -| \YooKassa\Common\Exceptions\ForbiddenException | | -| \YooKassa\Common\Exceptions\InternalServerError | | -| \YooKassa\Common\Exceptions\NotFoundException | | -| \YooKassa\Common\Exceptions\ResponseProcessingException | | -| \YooKassa\Common\Exceptions\TooManyRequestsException | | -| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок. | **Returns:** mixed - @@ -662,11 +691,11 @@ protected handleError(\YooKassa\Common\ResponseObject $response) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-CurlClient.md b/docs/classes/YooKassa-Client-CurlClient.md index 7de0c37f..0f40fc3a 100644 --- a/docs/classes/YooKassa-Client-CurlClient.md +++ b/docs/classes/YooKassa-Client-CurlClient.md @@ -508,11 +508,11 @@ public setTimeout(int $timeout) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-UserAgent.md b/docs/classes/YooKassa-Client-UserAgent.md index 19171d55..b865eb8a 100644 --- a/docs/classes/YooKassa-Client-UserAgent.md +++ b/docs/classes/YooKassa-Client-UserAgent.md @@ -311,11 +311,11 @@ public setModule(string $name, string $version) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client.md b/docs/classes/YooKassa-Client.md index a97eeed7..16c50ae9 100644 --- a/docs/classes/YooKassa-Client.md +++ b/docs/classes/YooKassa-Client.md @@ -10,16 +10,9 @@ --- ### Examples -Создание клиента +01-client.php 3 7 Создание клиента ```php -require_once '../vendor/autoload.php'; - -$client = new \YooKassa\Client(); -// по логин/паролю -$client->setAuth('xxxxxx', 'test_XXXXXXX'); -// или по oauth токену -$client->setAuthToken('token_XXXXXXX'); ``` @@ -34,6 +27,9 @@ $client->setAuthToken('token_XXXXXXX'); | public | [RECEIPTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_RECEIPTS_PATH) | | Точка входа для запросов к API по чекам | | public | [DEALS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_DEALS_PATH) | | Точка входа для запросов к API по сделкам | | public | [PAYOUTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYOUTS_PATH) | | Точка входа для запросов к API по выплатам | +| public | [PERSONAL_DATA_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PERSONAL_DATA_PATH) | | Точка входа для запросов к API по персональным данным | +| public | [SBP_BANKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SBP_BANKS_PATH) | | Точка входа для запросов к API по участникам СБП | +| public | [SELF_EMPLOYED_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SELF_EMPLOYED_PATH) | | Точка входа для запросов к API по самозанятым | | public | [IDEMPOTENCY_KEY_HEADER](../classes/YooKassa-Client-BaseClient.md#constant_IDEMPOTENCY_KEY_HEADER) | | Имя HTTP заголовка, используемого для передачи idempotence key | | public | [DEFAULT_DELAY](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_DELAY) | | Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 | | public | [DEFAULT_TRIES_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_TRIES_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | @@ -63,8 +59,10 @@ $client->setAuthToken('token_XXXXXXX'); | public | [createDeal()](../classes/YooKassa-Client.md#method_createDeal) | | Создание сделки. | | public | [createPayment()](../classes/YooKassa-Client.md#method_createPayment) | | Создание платежа. | | public | [createPayout()](../classes/YooKassa-Client.md#method_createPayout) | | Создание выплаты. | +| public | [createPersonalData()](../classes/YooKassa-Client.md#method_createPersonalData) | | Создание персональных данных | | public | [createReceipt()](../classes/YooKassa-Client.md#method_createReceipt) | | Отправка чека в облачную кассу | | public | [createRefund()](../classes/YooKassa-Client.md#method_createRefund) | | Проведение возврата платежа | +| public | [createSelfEmployed()](../classes/YooKassa-Client.md#method_createSelfEmployed) | | Создание самозанятого. | | public | [getApiClient()](../classes/YooKassa-Client-BaseClient.md#method_getApiClient) | | Возвращает CURL клиента для работы с API | | public | [getConfig()](../classes/YooKassa-Client-BaseClient.md#method_getConfig) | | Возвращает настройки клиента | | public | [getDealInfo()](../classes/YooKassa-Client.md#method_getDealInfo) | | Получить информацию о сделке | @@ -72,10 +70,13 @@ $client->setAuthToken('token_XXXXXXX'); | public | [getPaymentInfo()](../classes/YooKassa-Client.md#method_getPaymentInfo) | | Получить информацию о платеже | | public | [getPayments()](../classes/YooKassa-Client.md#method_getPayments) | | Получить список платежей магазина | | public | [getPayoutInfo()](../classes/YooKassa-Client.md#method_getPayoutInfo) | | Получить информацию о выплате | +| public | [getPersonalDataInfo()](../classes/YooKassa-Client.md#method_getPersonalDataInfo) | | Получить информацию о персональных данных | | public | [getReceiptInfo()](../classes/YooKassa-Client.md#method_getReceiptInfo) | | Получить информацию о чеке | | public | [getReceipts()](../classes/YooKassa-Client.md#method_getReceipts) | | Получить список чеков магазина | | public | [getRefundInfo()](../classes/YooKassa-Client.md#method_getRefundInfo) | | Получить информацию о возврате | | public | [getRefunds()](../classes/YooKassa-Client.md#method_getRefunds) | | Получить список возвратов платежей | +| public | [getSbpBanks()](../classes/YooKassa-Client.md#method_getSbpBanks) | | Получить список участников СБП | +| public | [getSelfEmployedInfo()](../classes/YooKassa-Client.md#method_getSelfEmployedInfo) | | Получить информацию о самозанятом | | public | [getWebhooks()](../classes/YooKassa-Client.md#method_getWebhooks) | | Список созданных Webhook | | public | [isNotificationIPTrusted()](../classes/YooKassa-Client-BaseClient.md#method_isNotificationIPTrusted) | | Метод проверяет, находится ли IP адрес среди IP адресов Юkassa, с которых отправляются уведомления | | public | [me()](../classes/YooKassa-Client.md#method_me) | | Информация о магазине | @@ -186,6 +187,39 @@ PAYOUTS_PATH = '/payouts' ``` + +###### PERSONAL_DATA_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по персональным данным + +```php +PERSONAL_DATA_PATH = '/personal_data' +``` + + + +###### SBP_BANKS_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по участникам СБП + +```php +SBP_BANKS_PATH = '/sbp_banks' +``` + + + +###### SELF_EMPLOYED_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по самозанятым + +```php +SELF_EMPLOYED_PATH = '/self_employed' +``` + + ###### IDEMPOTENCY_KEY_HEADER Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -235,7 +269,7 @@ DEFAULT_ATTEMPTS_COUNT = 3 Текущая версия библиотеки ```php -SDK_VERSION = '2.7.7' +SDK_VERSION = '2.8.0' ``` @@ -249,7 +283,7 @@ SDK_VERSION = '2.7.7' CURL клиент -**Type:** ApiClientInterface +**Type:** ApiClientInterface **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -266,7 +300,7 @@ CURL клиент Значение по умолчанию 3 -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -279,7 +313,7 @@ CURL клиент Настройки для CURL клиента -**Type:** array +**Type:** array **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -292,7 +326,7 @@ CURL клиент Объект для логирования работы SDK -**Type:** LoggerInterface|null +**Type:** LoggerInterface|null **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -305,7 +339,7 @@ CURL клиент shopId магазина -**Type:** string|int +**Type:** string|int **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -318,7 +352,7 @@ shopId магазина Секретный ключ магазина -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -335,7 +369,7 @@ shopId магазина Значение по умолчанию - 1800 миллисекунд. -**Type:** int +**Type:** int Значение в миллисекундах **Details:** * Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) @@ -407,42 +441,9 @@ public addWebhook(\YooKassa\Model\Webhook\Webhook|array $request, string|null $i **Returns:** \YooKassa\Model\Webhook\Webhook|null - ##### Examples: -Создание Webhook: +01-client.php 192 33 Создание Webhook: ```php -// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. -// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. -$client->setAuthToken('token_XXXXXXX'); -try { - $webHookUrl = 'https://merchant-site.ru/payment-notification'; - $needWebHookList = array( - \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, - \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED - ); - $currentWebHookList = $client->getWebhooks()->getItems(); - foreach ($needWebHookList as $event) { - $hookIsSet = false; - foreach ($currentWebHookList as $webHook) { - if ($webHook->getEvent() !== $event) { - continue; - } - if ($webHook->getUrl() !== $webHookUrl) { - $client->removeWebhook($webHook->getId()); - } else { - $hookIsSet = true; - } - break; - } - if (!$hookIsSet) { - $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); - } - } - $response = 'SUCCESS'; -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -490,18 +491,9 @@ public cancelPayment(string $paymentId, string|null $idempotencyKey = null) : \Y **Returns:** \YooKassa\Request\Payments\Payment\CancelResponse|null - ##### Examples: -Отменить незавершенную оплату заказа: +01-client.php 87 9 Отменить незавершенную оплату заказа: ```php -$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df'; -try { - $response = $client->cancelPayment($paymentId, uniqid('', true)); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -553,43 +545,9 @@ public capturePayment(\YooKassa\Request\Payments\Payment\CreateCaptureRequestInt **Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureResponse|null - ##### Examples: -Подтверждение платежа: +01-client.php 51 34 Подтверждение платежа: ```php -$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df'; -try { - $response = $client->capturePayment( - array( - 'amount' => array( - 'value' => '1500.00', - 'currency' => 'RUB', - ), - 'transfers' => array( - array( - 'account_id' => '123', - 'amount' => array( - 'value' => '1000.00', - 'currency' => 'RUB', - ), - ), - array( - 'account_id' => '456', - 'amount' => array( - 'value' => '500.00', - 'currency' => 'RUB', - ), - ), - ), - ), - $paymentId, - uniqid('', true) - ); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -612,12 +570,13 @@ public createDeal(\YooKassa\Request\Deals\CreateDealRequestInterface|array $deal Необходимо указать следующие параметры: Дополнительные параметры: @@ -645,27 +604,9 @@ public createDeal(\YooKassa\Request\Deals\CreateDealRequestInterface|array $deal **Returns:** \YooKassa\Request\Deals\CreateDealResponse|null - ##### Examples: -Запрос на создание сделки: +01-client.php 300 18 Запрос на создание сделки: ```php -// Запрос на создание сделки -try { - $response = $client->createDeal( - array( - 'type' => \YooKassa\Model\Deal\DealType::SAFE_DEAL, - 'fee_moment' => \YooKassa\Model\Deal\FeeMoment::PAYMENT_SUCCEEDED, - 'metadata' => array( - 'order_id' => '37', - ), - 'description' => 'SAFE_DEAL 123554642-2432FF344R', - ), - uniqid('', true) - ); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - ``` @@ -727,37 +668,9 @@ public createPayment(\YooKassa\Request\Payments\CreatePaymentRequestInterface|ar **Returns:** \YooKassa\Request\Payments\CreatePaymentResponse|null - ##### Examples: -Запрос на создание платежа: +01-client.php 21 28 Запрос на создание платежа: ```php -try { - $idempotenceKey = uniqid('', true); - $response = $client->createPayment( - array( - 'amount' => array( - 'value' => '1.00', - 'currency' => 'RUB', - ), - 'confirmation' => array( - 'type' => 'redirect', - 'return_url' => 'https://merchant-site.ru/payment-notification', - ), - 'description' => 'Оплата заказа на сумму 1 руб', - 'metadata' => array( - 'orderNumber' => 1001 - ), - 'capture' => true, - ), - $idempotenceKey - ); - $confirmation = $response->getConfirmation(); - $redirectUrl = $confirmation->getConfirmationUrl(); - // Далее производим редирект на полученный URL -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -793,7 +706,7 @@ public createPayout(\YooKassa\Request\Payouts\CreatePayoutRequestInterface|array **Details:** @@ -820,36 +733,59 @@ public createPayout(\YooKassa\Request\Payouts\CreatePayoutRequestInterface|array **Returns:** \YooKassa\Request\Payouts\CreatePayoutResponse|null - ##### Examples: -Запрос на создание выплаты: +01-client.php 358 27 Запрос на создание выплаты: ```php -// Создание выплаты -$request = array( - 'amount' => array( - 'value' => '80.00', - 'currency' => 'RUB', - ), - 'payout_destination_data' => array( - 'type' => \YooKassa\Model\PaymentMethodType::YOO_MONEY, - 'accountNumber' => '4100116075156746', - ), - 'description' => 'Выплата по заказу №37', - 'metadata' => array( - 'order_id' => '37' - ), - 'deal' => array( - 'id' => 'dl-2909e77d-0022-5000-8000-0c37205b3208', - ), -); -$idempotenceKey = uniqid('', true); -try { - $idempotenceKey = uniqid('', true); - $result = $client->createPayout($request, $idempotenceKey - ); -} catch (\Exception $e) { - $result = $e; -} +``` + + + +#### public createPersonalData() : \YooKassa\Request\PersonalData\PersonalDataResponse|null + +```php +public createPersonalData(\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|array $request, string|null $idempotencyKey = null) : \YooKassa\Request\PersonalData\PersonalDataResponse|null +``` + +**Summary** + +Создание персональных данных + +**Description** + +Используйте этот запрос, чтобы создать в ЮKassa [объект персональных данных](#personal_data_object). +В запросе необходимо передать фамилию, имя, отчество пользователя и указать, с какой целью эти данные будут использоваться. +Идентификатор созданного объекта персональных данных необходимо использовать в запросе на проведение выплаты через СБП с проверкой получателя. +[Подробнее о выплатах с проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface OR array | request | | +| string OR null | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено. | +| \Exception | | + +**Returns:** \YooKassa\Request\PersonalData\PersonalDataResponse|null - Объект персональных данных +##### Examples: +01-client.php 397 16 Запрос на создание персональных данных: + +```php ``` @@ -896,43 +832,9 @@ public createReceipt(\YooKassa\Request\Receipts\CreatePostReceiptRequestInterfac **Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse|null - ##### Examples: -Запрос на создание чека: +01-client.php 98 34 Запрос на создание чека: ```php -try { - $response = $client->createReceipt( - array( - 'customer' => array( - 'email' => 'johndoe@yoomoney.ru', - 'phone' => '79000000000', - ), - 'type' => 'payment', - 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', - 'on_behalf_of' => '123', - 'send' => true, - 'items' => array( - array( - 'description' => 'Платок Gucci', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3000.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ), - ), - 'tax_system_code' => 1, - ), - uniqid('', true) - ); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -979,35 +881,60 @@ public createRefund(\YooKassa\Request\Refunds\CreateRefundRequestInterface|array **Returns:** \YooKassa\Request\Refunds\CreateRefundResponse|null - ##### Examples: -Запрос на создание возврата: +01-client.php 134 26 Запрос на создание возврата: ```php -try { - $response = $client->createRefund( - array( - 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', - 'amount' => array( - 'value' => '1000.00', - 'currency' => 'RUB', - ), - 'sources' => array( - array( - 'account_id' => '456', - 'amount' => array( - 'value' => '1000.00', - 'currency' => 'RUB', - ) - ), - ), - ), - uniqid('', true) - ); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} -var_dump($response); +``` + + + +#### public createSelfEmployed() : \YooKassa\Request\SelfEmployed\SelfEmployedResponse|null + +```php +public createSelfEmployed(\YooKassa\Request\SelfEmployed\SelfEmployedRequest|array $selfEmployed, string|null $idempotenceKey = null) : \YooKassa\Request\SelfEmployed\SelfEmployedResponse|null +``` + +**Summary** + +Создание самозанятого. + +**Description** + +Используйте этот запрос, чтобы создать в ЮKassa [объект самозанятого](https://yookassa.ru/developers/api?codeLang=bash#self_employed_object). + +В запросе необходимо передать ИНН или телефон самозанятого для идентификации в сервисе Мой налог, +сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков и описание самозанятого. + +Идентификатор созданного объекта самозанятого необходимо использовать в запросе на проведение выплаты. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\SelfEmployed\SelfEmployedRequest OR array | selfEmployed | | +| string OR null | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено. | + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedResponse|null - +##### Examples: +01-client.php 425 14 Запрос на создание самозанятого: + +```php ``` @@ -1085,17 +1012,9 @@ public getDealInfo(string $dealId) : \YooKassa\Model\DealInterface|null **Returns:** \YooKassa\Model\DealInterface|null - ##### Examples: -Получить информацию о сделке: +01-client.php 320 8 Получить информацию о сделке: ```php -var_dump($response); - -// Получить информацию о сделке -try { - $response = $client->getDealInfo('dl-2909e77d-1022-5003-8004-0c37205b3208'); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; ``` @@ -1143,36 +1062,9 @@ public getDeals(\YooKassa\Request\Deals\DealsRequestInterface|array|null $filter **Returns:** \YooKassa\Request\Deals\DealsResponse|null - ##### Examples: -Получить список сделок с фильтрацией: +01-client.php 330 27 Получить список сделок с фильтрацией: ```php -var_dump($response); - -// Получить список сделок с фильтрацией -$cursor = null; -$params = array( - 'limit' => 30, - 'status' => \YooKassa\Model\Deal\DealStatus::OPENED, - 'full_text_search' => 'DEAL', - 'created_at_gte' => '2021-10-01T00:00:00.000Z', - 'created_at_lt' => '2021-11-01T23:59:59.999Z', -); -try { - do { - $params['cursor'] = $cursor; - $deals = $client->getDeals($params); - foreach ($deals->getItems() as $deal) { - $res = array( - $deal->getCreatedAt()->format('Y-m-d H:i:s'), - $deal->getBalance()->getValue() . ' ' . $deal->getBalance()->getCurrency(), - $deal->getPayoutBalance()->getValue() . ' ' . $deal->getBalance()->getCurrency(), - $deal->getStatus(), - $deal->getId(), - ); - echo implode(' - ', $res) . "\n"; - } - } while ($cursor = $deals->getNextCursor()); -} catch (\Exception $e) { ``` @@ -1216,17 +1108,9 @@ public getPaymentInfo(string $paymentId) : \YooKassa\Model\PaymentInterface|null **Returns:** \YooKassa\Model\PaymentInterface|null - Объект платежа ##### Examples: -Получить информацию о платеже: +01-client.php 162 8 Получить информацию о платеже: ```php -try { - $response = $client->getPaymentInfo('24e89cb0-000f-5000-9000-1de77fa0d6df'); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -1274,32 +1158,9 @@ public getPayments(\YooKassa\Request\Payments\PaymentsRequestInterface|array|nul **Returns:** \YooKassa\Request\Payments\PaymentsResponse|null - ##### Examples: -Получить список платежей магазина с фильтрацией: +01-client.php 227 23 Получить список платежей магазина с фильтрацией: ```php -// Получить список платежей с фильтрацией -$cursor = null; -$params = array( - 'limit' => 30, - 'status' => \YooKassa\Model\PaymentStatus::CANCELED, - 'payment_method' => \YooKassa\Model\PaymentMethodType::BANK_CARD, - 'created_at_gte' => '2021-01-01T00:00:00.000Z', - 'created_at_lt' => '2021-03-30T23:59:59.999Z', -); -try { - do { - $params['cursor'] = $cursor; - $payments = $client->getPayments($params); - foreach ($payments->getItems() as $payment) { - echo $payment->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . - $payment->getStatus() . ' - ' . - $payment->getId() . "\n"; - } - } while ($cursor = $payments->getNextCursor()); -} catch (\Exception $e) { - $response = $e; -} - ``` @@ -1343,17 +1204,55 @@ public getPayoutInfo(string $payoutId) : \YooKassa\Model\PayoutInterface|null **Returns:** \YooKassa\Model\PayoutInterface|null - Объект выплаты ##### Examples: -Получить информацию о выплате: +01-client.php 387 8 Получить информацию о выплате: ```php -// Получить информацию о выплате -$payoutId = 'po-285c0ab7-0003-5000-9000-0e1166498fda'; -try { - $response = $client->getPayoutInfo($payoutId); -} catch (\Exception $e) { - $response = $e; -} +``` + + + +#### public getPersonalDataInfo() : \YooKassa\Model\PersonalData\PersonalDataInterface|null + +```php +public getPersonalDataInfo(string $personalDataId) : \YooKassa\Model\PersonalData\PersonalDataInterface|null +``` + +**Summary** + +Получить информацию о персональных данных + +**Description** + +Запрос позволяет получить информацию о текущем состоянии персональных данных по их уникальному идентификатору. +Выдает объект платежа {@link} в актуальном статусе. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | personalDataId | Идентификатор персональных данных | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено. | + +**Returns:** \YooKassa\Model\PersonalData\PersonalDataInterface|null - Объект персональных данных +##### Examples: +01-client.php 415 8 Получить информацию о персональных данных: + +```php ``` @@ -1397,17 +1296,9 @@ public getReceiptInfo(string $receiptId) : \YooKassa\Request\Receipts\ReceiptRes **Returns:** \YooKassa\Request\Receipts\ReceiptResponseInterface|null - ##### Examples: -Получить информацию о чеке: +01-client.php 172 8 Получить информацию о чеке: ```php -try { - $response = $client->getReceiptInfo('ra-27ed1660-0001-0050-7a5e-10f80e0f0f29'); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -1456,30 +1347,9 @@ public getReceipts(\YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterf **Returns:** \YooKassa\Request\Receipts\ReceiptsResponse - ##### Examples: -Получить список чеков магазина с фильтрацией: +01-client.php 252 21 Получить список чеков магазина с фильтрацией: ```php -// Получить список чеков с фильтрацией -$cursor = null; -$params = array( - 'limit' => 30, - 'status' => \YooKassa\Model\ReceiptRegistrationStatus::SUCCEEDED, - 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', - 'created_at_gte' => '2021-01-01T00:00:00.000Z', - 'created_at_lt' => '2021-03-30T23:59:59.999Z', -); -try { - do { - $params['cursor'] = $cursor; - $receipts = $client->getReceipts($params); - foreach ($receipts->getItems() as $receipt) { - echo $receipt->getStatus() . ' - ' . $receipt->getId() . "\n"; - } - } while ($cursor = $receipts->getNextCursor()); -} catch (\Exception $e) { - $response = $e; -} - ``` @@ -1524,17 +1394,9 @@ public getRefundInfo(string $refundId) : \YooKassa\Request\Refunds\RefundRespons **Returns:** \YooKassa\Request\Refunds\RefundResponse|null - ##### Examples: -Получить информацию о возврате: +01-client.php 182 8 Получить информацию о возврате: ```php -try { - $response = $client->getRefundInfo('216749f7-0016-50be-b000-078d43a63ae4'); - echo $response->getStatus(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -1582,32 +1444,96 @@ public getRefunds(\YooKassa\Request\Refunds\RefundsRequestInterface|array|null $ **Returns:** \YooKassa\Request\Refunds\RefundsResponse|null - ##### Examples: -Получить список возвратов платежей магазина с фильтрацией: +01-client.php 275 23 Получить список возвратов платежей магазина с фильтрацией: ```php -// Получить список возвратов с фильтрацией -$cursor = null; -$params = array( - 'limit' => 30, - 'status' => \YooKassa\Model\RefundStatus::SUCCEEDED, - 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', - 'created_at_gte' => '2021-01-01T00:00:00.000Z', - 'created_at_lt' => '2021-03-30T23:59:59.999Z', -); -try { - do { - $params['cursor'] = $cursor; - $refunds = $client->getRefunds($params); - foreach ($refunds->getItems() as $refund) { - echo $refund->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . - $refund->getStatus() . ' - ' . - $refund->getId() . "\n"; - } - } while ($cursor = $refunds->getNextCursor()); -} catch (\Exception $e) { - $response = $e; -} +``` + + + +#### public getSbpBanks() : \YooKassa\Request\Payouts\SbpBanksResponse|null + +```php +public getSbpBanks() : \YooKassa\Request\Payouts\SbpBanksResponse|null +``` + +**Summary** + +Получить список участников СБП + +**Description** + +С помощью этого запроса вы можете получить актуальный список всех участников СБП. +Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать +в запросе на создание выплаты. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено. | + +**Returns:** \YooKassa\Request\Payouts\SbpBanksResponse|null - +##### Examples: +01-client.php 415 7 Получить информацию о персональных данных: + +```php + +``` + + + +#### public getSelfEmployedInfo() : \YooKassa\Model\SelfEmployed\SelfEmployedInterface|null + +```php +public getSelfEmployedInfo(string $selfEmployedId) : \YooKassa\Model\SelfEmployed\SelfEmployedInterface|null +``` + +**Summary** + +Получить информацию о самозанятом + +**Description** + +С помощью этого запроса вы можете получить информацию о текущем статусе самозанятого по его уникальному идентификатору. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | selfEmployedId | Идентификатор самозанятого | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено. | + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedInterface|null - Объект информации о самозанятом +##### Examples: +01-client.php 441 8 Получить информацию о самозанятом: + +```php ``` @@ -1646,41 +1572,9 @@ public getWebhooks() : \YooKassa\Request\Webhook\WebhookListResponse|null **Returns:** \YooKassa\Request\Webhook\WebhookListResponse|null - ##### Examples: -Список созданных Webhook: +01-client.php 192 33 Список созданных Webhook: ```php -// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. -// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. -$client->setAuthToken('token_XXXXXXX'); -try { - $webHookUrl = 'https://merchant-site.ru/payment-notification'; - $needWebHookList = array( - \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, - \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED - ); - $currentWebHookList = $client->getWebhooks()->getItems(); - foreach ($needWebHookList as $event) { - $hookIsSet = false; - foreach ($currentWebHookList as $webHook) { - if ($webHook->getEvent() !== $event) { - continue; - } - if ($webHook->getUrl() !== $webHookUrl) { - $client->removeWebhook($webHook->getId()); - } else { - $hookIsSet = true; - } - break; - } - if (!$hookIsSet) { - $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); - } - } - $response = 'SUCCESS'; -} catch (\Exception $e) { - $response = $e; -} - ``` @@ -1702,12 +1596,12 @@ public isNotificationIPTrusted(string $ip) : bool ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | ip | - IPv4 или IPv6 адрес webhook уведомления | +| string | ip | IPv4 или IPv6 адрес webhook уведомления | ##### Throws: | Type | Description | | ---- | ----------- | -| \Exception | - исключение будет выброшено, если будет передан IP адрес неверного формата | +| \Exception | Выбрасывается, если будет передан IP адрес неверного формата | **Returns:** bool - @@ -1751,16 +1645,9 @@ public me(array|string|int|null $filter = null) : array|null **Returns:** array|null - Массив с информацией о магазине ##### Examples: -Информация о магазине: +01-client.php 12 7 Информация о магазине: ```php -try { - $response = $client->me(); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -1806,41 +1693,9 @@ public removeWebhook(string $webhookId, string|null $idempotencyKey = null) : \Y **Returns:** \YooKassa\Model\Webhook\Webhook|null - ##### Examples: -Удаление Webhook: +01-client.php 192 33 Удаление Webhook: ```php -// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. -// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. -$client->setAuthToken('token_XXXXXXX'); -try { - $webHookUrl = 'https://merchant-site.ru/payment-notification'; - $needWebHookList = array( - \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, - \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED - ); - $currentWebHookList = $client->getWebhooks()->getItems(); - foreach ($needWebHookList as $event) { - $hookIsSet = false; - foreach ($currentWebHookList as $webHook) { - if ($webHook->getEvent() !== $event) { - continue; - } - if ($webHook->getUrl() !== $webHookUrl) { - $client->removeWebhook($webHook->getId()); - } else { - $hookIsSet = true; - } - break; - } - if (!$hookIsSet) { - $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); - } - } - $response = 'SUCCESS'; -} catch (\Exception $e) { - $response = $e; -} - ``` @@ -1889,10 +1744,9 @@ public setAuth(string $login, string $password) : $this **Returns:** $this - ##### Examples: -Пример авторизации: +01-client.php 7 1 Пример авторизации: ```php -$client->setAuth('xxxxxx', 'test_XXXXXXX'); ``` @@ -1918,10 +1772,9 @@ public setAuthToken(string $token) : $this **Returns:** $this - ##### Examples: -Пример авторизации: +01-client.php 9 1 Пример авторизации: ```php -$client->setAuthToken('token_XXXXXXX'); ``` @@ -2031,9 +1884,9 @@ protected decodeData(\YooKassa\Common\ResponseObject $response) : array ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Common\ResponseObject | response | | +| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API | -**Returns:** array - +**Returns:** array - Массив данных @@ -2053,7 +1906,7 @@ protected delay(\YooKassa\Common\ResponseObject $response) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Common\ResponseObject | response | | +| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API | **Returns:** mixed - @@ -2075,21 +1928,21 @@ protected encodeData(array $serializedData) : string ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array | serializedData | | +| array | serializedData | Массив данных для кодировки | ##### Throws: | Type | Description | | ---- | ----------- | -| \Exception | | +| \Exception | Выбрасывается, если не удалось конвертировать данные в строку JSON | -**Returns:** string - +**Returns:** string - Строка JSON #### protected execute() : mixed|\YooKassa\Common\ResponseObject ```php -protected execute(string $path, string $method, array $queryParams, null $httpBody = null, array $headers = array()) : mixed|\YooKassa\Common\ResponseObject +protected execute(string $path, string $method, array $queryParams, string|null $httpBody = null, array $headers = array()) : mixed|\YooKassa\Common\ResponseObject ``` **Summary** @@ -2102,11 +1955,11 @@ protected execute(string $path, string $method, array $queryParams, null $httpBo ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | path | | -| string | method | | -| array | queryParams | | -| null | httpBody | | -| array | headers | | +| string | path | URL запроса | +| string | method | HTTP метод | +| array | queryParams | Массив GET параметров запроса | +| string OR null | httpBody | Тело запроса | +| array | headers | Массив заголовков запроса | ##### Throws: | Type | Description | @@ -2141,14 +1994,15 @@ protected handleError(\YooKassa\Common\ResponseObject $response) : mixed ##### Throws: | Type | Description | | ---- | ----------- | -| \YooKassa\Common\Exceptions\ApiException | | -| \YooKassa\Common\Exceptions\BadApiRequestException | | -| \YooKassa\Common\Exceptions\ForbiddenException | | -| \YooKassa\Common\Exceptions\InternalServerError | | -| \YooKassa\Common\Exceptions\NotFoundException | | -| \YooKassa\Common\Exceptions\ResponseProcessingException | | -| \YooKassa\Common\Exceptions\TooManyRequestsException | | -| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки. | +| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. | +| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. | +| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. | +| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден. | +| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена. | +| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. | +| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. | +| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок. | **Returns:** mixed - @@ -2164,11 +2018,11 @@ protected handleError(\YooKassa\Common\ResponseObject $response) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractEnum.md b/docs/classes/YooKassa-Common-AbstractEnum.md index 5eb3c409..463e1d9c 100644 --- a/docs/classes/YooKassa-Common-AbstractEnum.md +++ b/docs/classes/YooKassa-Common-AbstractEnum.md @@ -38,7 +38,7 @@ #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -113,11 +113,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractObject.md b/docs/classes/YooKassa-Common-AbstractObject.md index ac01749d..270922e0 100644 --- a/docs/classes/YooKassa-Common-AbstractObject.md +++ b/docs/classes/YooKassa-Common-AbstractObject.md @@ -22,11 +22,11 @@ | public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -176,109 +176,89 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -327,11 +307,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractPaymentRequest.md b/docs/classes/YooKassa-Common-AbstractPaymentRequest.md index caadb214..04866ca9 100644 --- a/docs/classes/YooKassa-Common-AbstractPaymentRequest.md +++ b/docs/classes/YooKassa-Common-AbstractPaymentRequest.md @@ -38,11 +38,11 @@ | public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты | | public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | | public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | | public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | | public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | @@ -55,7 +55,7 @@ --- ### Details * File: [lib/Common/AbstractPaymentRequest.php](../../lib/Common/AbstractPaymentRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -76,7 +76,7 @@ Сумма -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -88,7 +88,7 @@ Данные фискального чека 54-ФЗ -**Type:** ReceiptInterface +**Type:** ReceiptInterface **Details:** @@ -100,7 +100,7 @@ Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** @@ -383,109 +383,89 @@ public hasTransfers() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -661,11 +641,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md b/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md index 60235f08..0f79f595 100644 --- a/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md +++ b/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md @@ -63,7 +63,7 @@ Сумма -**Type:** MonetaryAmount +**Type:** MonetaryAmount **Details:** @@ -75,7 +75,7 @@ Инстанс собираемого запроса -**Type:** AbstractRequest +**Type:** AbstractRequest **Details:** * Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) @@ -88,7 +88,7 @@ Объект с информацией о чеке -**Type:** Receipt +**Type:** Receipt **Details:** @@ -100,7 +100,7 @@ Массив платежей в пользу разных мерчантов -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** @@ -457,11 +457,11 @@ protected initCurrentObject() : self ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRefundRequest.md b/docs/classes/YooKassa-Common-AbstractRefundRequest.md index a0bba2a9..2a874d6a 100644 --- a/docs/classes/YooKassa-Common-AbstractRefundRequest.md +++ b/docs/classes/YooKassa-Common-AbstractRefundRequest.md @@ -37,11 +37,11 @@ | public | [hasAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма возврата | | public | [hasPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasPaymentId) | | Проверяет, был ли установлена идентификатор платежа | | public | [hasReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasReceipt) | | Проверяет наличие чека | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setAmount) | | Устанавливает сумму | | public | [setPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа для которого создаётся возврат | | public | [setReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setReceipt) | | Устанавливает чек | @@ -53,7 +53,7 @@ --- ### Details * File: [lib/Common/AbstractRefundRequest.php](../../lib/Common/AbstractRefundRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -74,7 +74,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -86,7 +86,7 @@ Идентификатор платежа для которого создаётся возврат -**Type:** string +**Type:** string **Details:** @@ -364,109 +364,89 @@ public hasReceipt() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -632,11 +612,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRequest.md b/docs/classes/YooKassa-Common-AbstractRequest.md index 5ad1f776..1d3a35df 100644 --- a/docs/classes/YooKassa-Common-AbstractRequest.md +++ b/docs/classes/YooKassa-Common-AbstractRequest.md @@ -24,11 +24,11 @@ | public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | public | [validate()](../classes/YooKassa-Common-AbstractRequest.md#method_validate) | | Валидирует текущий запрос, проверяет все ли нужные свойства установлены | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -212,109 +212,89 @@ public getLastValidationError() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -402,11 +382,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRequestBuilder.md b/docs/classes/YooKassa-Common-AbstractRequestBuilder.md index 79f7ccce..b7661363 100644 --- a/docs/classes/YooKassa-Common-AbstractRequestBuilder.md +++ b/docs/classes/YooKassa-Common-AbstractRequestBuilder.md @@ -43,7 +43,7 @@ Инстанс собираемого запроса -**Type:** AbstractRequest +**Type:** AbstractRequest **Details:** @@ -152,11 +152,11 @@ Abstract protected initCurrentObject() : \YooKassa\Common\AbstractRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md b/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md index 13707a81..b081f217 100644 --- a/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md +++ b/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md @@ -30,7 +30,7 @@ --- ### Details * File: [lib/Common/Exceptions/ApiConnectionException.php](../../lib/Common/Exceptions/ApiConnectionException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\Exception](\Exception) * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -41,7 +41,7 @@ #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -50,7 +50,7 @@ #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -121,11 +121,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ApiException.md b/docs/classes/YooKassa-Common-Exceptions-ApiException.md index 9e9c935f..dc607d17 100644 --- a/docs/classes/YooKassa-Common-Exceptions-ApiException.md +++ b/docs/classes/YooKassa-Common-Exceptions-ApiException.md @@ -40,7 +40,7 @@ #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** @@ -48,7 +48,7 @@ #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** @@ -118,11 +118,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md b/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md index 6963bc07..62747f9a 100644 --- a/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md +++ b/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md @@ -41,7 +41,7 @@ #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -50,7 +50,7 @@ #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -121,11 +121,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md b/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md index df3098db..b447a36a 100644 --- a/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md +++ b/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md @@ -69,7 +69,7 @@ HTTP_CODE = 400 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -78,7 +78,7 @@ HTTP_CODE = 400 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -147,11 +147,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md b/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md index 61d10ad6..c1d02b07 100644 --- a/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md +++ b/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md @@ -18,7 +18,7 @@ --- ### Details * File: [lib/Common/Exceptions/EmptyPropertyValueException.php](../../lib/Common/Exceptions/EmptyPropertyValueException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\InvalidArgumentException](\InvalidArgumentException) * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) @@ -74,11 +74,11 @@ public getProperty() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md b/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md index 5b7c5d9e..c83323fa 100644 --- a/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md +++ b/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md @@ -62,11 +62,11 @@ Constructor ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md b/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md index fb0a538d..9db4e936 100644 --- a/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md +++ b/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md @@ -69,7 +69,7 @@ HTTP_CODE = 403 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -78,7 +78,7 @@ HTTP_CODE = 403 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -147,11 +147,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md b/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md index 917ec071..d8531f90 100644 --- a/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md +++ b/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md @@ -72,7 +72,7 @@ HTTP_CODE = 500 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -81,7 +81,7 @@ HTTP_CODE = 500 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -150,11 +150,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md index 47c35ccf..1bb7540a 100644 --- a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md @@ -18,7 +18,7 @@ --- ### Details * File: [lib/Common/Exceptions/InvalidPropertyException.php](../../lib/Common/Exceptions/InvalidPropertyException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\InvalidArgumentException](\InvalidArgumentException) * \YooKassa\Common\Exceptions\InvalidPropertyException @@ -73,11 +73,11 @@ public getProperty() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md index f24c7dde..9e1d8ede 100644 --- a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md @@ -19,7 +19,7 @@ --- ### Details * File: [lib/Common/Exceptions/InvalidPropertyValueException.php](../../lib/Common/Exceptions/InvalidPropertyValueException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\InvalidArgumentException](\InvalidArgumentException) * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) @@ -89,11 +89,11 @@ public getValue() : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md index c6ee5ec5..94f646a2 100644 --- a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md @@ -19,7 +19,7 @@ --- ### Details * File: [lib/Common/Exceptions/InvalidPropertyValueTypeException.php](../../lib/Common/Exceptions/InvalidPropertyValueTypeException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\InvalidArgumentException](\InvalidArgumentException) * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) @@ -89,11 +89,11 @@ public getType() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md index f9cfb35a..921ea86c 100644 --- a/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md @@ -18,7 +18,7 @@ --- ### Details * File: [lib/Common/Exceptions/InvalidRequestException.php](../../lib/Common/Exceptions/InvalidRequestException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\RuntimeException](\RuntimeException) * \YooKassa\Common\Exceptions\InvalidRequestException @@ -73,11 +73,11 @@ public getRequestObject() : \YooKassa\Common\AbstractRequest|null ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-JsonException.md b/docs/classes/YooKassa-Common-Exceptions-JsonException.md index dfe59bda..79d8eac1 100644 --- a/docs/classes/YooKassa-Common-Exceptions-JsonException.md +++ b/docs/classes/YooKassa-Common-Exceptions-JsonException.md @@ -23,7 +23,7 @@ --- ### Details * File: [lib/Common/Exceptions/JsonException.php](../../lib/Common/Exceptions/JsonException.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\UnexpectedValueException](\UnexpectedValueException) * \YooKassa\Common\Exceptions\JsonException @@ -71,11 +71,11 @@ public __construct(mixed $message = "", mixed $code, mixed $previous = ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md b/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md index dc99c857..73e7d565 100644 --- a/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md +++ b/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md @@ -69,7 +69,7 @@ HTTP_CODE = 404 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -78,7 +78,7 @@ HTTP_CODE = 404 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -147,11 +147,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md b/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md index 5418dd42..e8ceaa4d 100644 --- a/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md +++ b/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md @@ -69,7 +69,7 @@ HTTP_CODE = 202 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -78,7 +78,7 @@ HTTP_CODE = 202 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -147,11 +147,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md b/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md index 2181face..dee8cd93 100644 --- a/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md +++ b/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md @@ -69,7 +69,7 @@ HTTP_CODE = 429 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -78,7 +78,7 @@ HTTP_CODE = 429 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -147,11 +147,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md b/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md index 3d02ef1d..a84fcfcc 100644 --- a/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md +++ b/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md @@ -72,7 +72,7 @@ HTTP_CODE = 401 #### protected $responseBody : mixed --- -**Type:** mixed +**Type:** mixed **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -81,7 +81,7 @@ HTTP_CODE = 401 #### protected $responseHeaders : string[] --- -**Type:** string[] +**Type:** string[] **Details:** * Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) @@ -150,11 +150,11 @@ public getResponseHeaders() : string[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-HttpVerb.md b/docs/classes/YooKassa-Common-HttpVerb.md index d3460b03..d31a4f5a 100644 --- a/docs/classes/YooKassa-Common-HttpVerb.md +++ b/docs/classes/YooKassa-Common-HttpVerb.md @@ -12,13 +12,13 @@ ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [GET](../classes/YooKassa-Common-HttpVerb.md#constant_GET) | | | -| public | [POST](../classes/YooKassa-Common-HttpVerb.md#constant_POST) | | | -| public | [PATCH](../classes/YooKassa-Common-HttpVerb.md#constant_PATCH) | | | -| public | [HEAD](../classes/YooKassa-Common-HttpVerb.md#constant_HEAD) | | | -| public | [OPTIONS](../classes/YooKassa-Common-HttpVerb.md#constant_OPTIONS) | | | -| public | [PUT](../classes/YooKassa-Common-HttpVerb.md#constant_PUT) | | | -| public | [DELETE](../classes/YooKassa-Common-HttpVerb.md#constant_DELETE) | | | +| public | [GET](../classes/YooKassa-Common-HttpVerb.md#constant_GET) | | Http метод GET | +| public | [POST](../classes/YooKassa-Common-HttpVerb.md#constant_POST) | | Http метод POST | +| public | [PATCH](../classes/YooKassa-Common-HttpVerb.md#constant_PATCH) | | Http метод PATCH | +| public | [HEAD](../classes/YooKassa-Common-HttpVerb.md#constant_HEAD) | | Http метод HEAD | +| public | [OPTIONS](../classes/YooKassa-Common-HttpVerb.md#constant_OPTIONS) | | Http метод OPTIONS | +| public | [PUT](../classes/YooKassa-Common-HttpVerb.md#constant_PUT) | | Http метод PUT | +| public | [DELETE](../classes/YooKassa-Common-HttpVerb.md#constant_DELETE) | | Http метод DELETE | --- ### Properties @@ -37,7 +37,7 @@ --- ### Details * File: [lib/Common/HttpVerb.php](../../lib/Common/HttpVerb.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Common\HttpVerb @@ -46,6 +46,8 @@ ## Constants ###### GET +Http метод GET + ```php GET = 'GET' ``` @@ -53,6 +55,8 @@ GET = 'GET' ###### POST +Http метод POST + ```php POST = 'POST' ``` @@ -60,6 +64,8 @@ POST = 'POST' ###### PATCH +Http метод PATCH + ```php PATCH = 'PATCH' ``` @@ -67,6 +73,8 @@ PATCH = 'PATCH' ###### HEAD +Http метод HEAD + ```php HEAD = 'HEAD' ``` @@ -74,6 +82,8 @@ HEAD = 'HEAD' ###### OPTIONS +Http метод OPTIONS + ```php OPTIONS = 'OPTIONS' ``` @@ -81,6 +91,8 @@ OPTIONS = 'OPTIONS' ###### PUT +Http метод PUT + ```php PUT = 'PUT' ``` @@ -88,6 +100,8 @@ PUT = 'PUT' ###### DELETE +Http метод DELETE + ```php DELETE = 'DELETE' ``` @@ -99,7 +113,7 @@ DELETE = 'DELETE' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -174,11 +188,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-LoggerWrapper.md b/docs/classes/YooKassa-Common-LoggerWrapper.md index 043594fc..caf5e683 100644 --- a/docs/classes/YooKassa-Common-LoggerWrapper.md +++ b/docs/classes/YooKassa-Common-LoggerWrapper.md @@ -26,7 +26,7 @@ --- ### Details * File: [lib/Common/LoggerWrapper.php](../../lib/Common/LoggerWrapper.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Common\LoggerWrapper * Implements: @@ -294,11 +294,11 @@ that are not necessarily wrong. ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-ResponseObject.md b/docs/classes/YooKassa-Common-ResponseObject.md index 2ca89585..d8a60a39 100644 --- a/docs/classes/YooKassa-Common-ResponseObject.md +++ b/docs/classes/YooKassa-Common-ResponseObject.md @@ -45,7 +45,7 @@ Тело ответа -**Type:** mixed +**Type:** mixed **Details:** @@ -57,7 +57,7 @@ HTTP код ответа -**Type:** int|string +**Type:** int|string **Details:** @@ -69,7 +69,7 @@ HTTP код ответа Массив заголовков ответа -**Type:** array +**Type:** array **Details:** @@ -157,11 +157,11 @@ public getHeaders() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md index 7c88bd38..defbc93c 100644 --- a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md +++ b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md @@ -18,7 +18,7 @@ --- ### Details * File: [lib/Helpers/Config/ConfigurationLoader.php](../../lib/Helpers/Config/ConfigurationLoader.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Helpers\Config\ConfigurationLoader * Implements: @@ -68,11 +68,11 @@ public load(mixed $filePath = null) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md index 2ae6c3ed..8a028065 100644 --- a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md +++ b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md @@ -17,7 +17,7 @@ --- ### Details * File: [lib/Helpers/Config/ConfigurationLoaderInterface.php](../../lib/Helpers/Config/ConfigurationLoaderInterface.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -59,11 +59,11 @@ public load() : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-ProductCode.md b/docs/classes/YooKassa-Helpers-ProductCode.md index 2d903c8d..2ded1f76 100644 --- a/docs/classes/YooKassa-Helpers-ProductCode.md +++ b/docs/classes/YooKassa-Helpers-ProductCode.md @@ -10,28 +10,14 @@ --- ### Examples -Вариант через метод +04-product-code.php 6 7 Вариант через метод ```php -$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh'; -$productCode = new \YooKassa\Helpers\ProductCode($inputDataMatrix); -$receiptItem = new \YooKassa\Model\ReceiptItem(); -$receiptItem->setProductCode($productCode); -$receiptItem->setMarkCodeInfo($productCode->getMarkCodeInfo()); - -var_dump($receiptItem); ``` -Вариант через массив +04-product-code.php 15 7 Вариант через массив ```php -$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh'; -$receiptItem = new \YooKassa\Model\ReceiptItem(array( - 'product_code' => (string)($code = new \YooKassa\Helpers\ProductCode($inputDataMatrix)), - 'mark_code_info' => $code->getMarkCodeInfo() -)); - -var_dump($receiptItem); ``` @@ -630,11 +616,11 @@ public validate() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Random.md b/docs/classes/YooKassa-Helpers-Random.md index b76ff3f5..e2b17418 100644 --- a/docs/classes/YooKassa-Helpers-Random.md +++ b/docs/classes/YooKassa-Helpers-Random.md @@ -238,11 +238,11 @@ Static public value(array $values, bool $useBest = true) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-RawHeadersParser.md b/docs/classes/YooKassa-Helpers-RawHeadersParser.md index d4a9c32a..2fbcf75b 100644 --- a/docs/classes/YooKassa-Helpers-RawHeadersParser.md +++ b/docs/classes/YooKassa-Helpers-RawHeadersParser.md @@ -17,7 +17,7 @@ --- ### Details * File: [lib/Helpers/RawHeadersParser.php](../../lib/Helpers/RawHeadersParser.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Helpers\RawHeadersParser @@ -52,11 +52,11 @@ Static public parse(mixed $rawHeaders) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-SecurityHelper.md b/docs/classes/YooKassa-Helpers-SecurityHelper.md index a81c0be4..e969de14 100644 --- a/docs/classes/YooKassa-Helpers-SecurityHelper.md +++ b/docs/classes/YooKassa-Helpers-SecurityHelper.md @@ -17,7 +17,7 @@ --- ### Details * File: [lib/Helpers/SecurityHelper.php](../../lib/Helpers/SecurityHelper.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Helpers\SecurityHelper @@ -61,11 +61,11 @@ public isIPTrusted($ip) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-StringObject.md b/docs/classes/YooKassa-Helpers-StringObject.md index 2f579ab2..2442e5e7 100644 --- a/docs/classes/YooKassa-Helpers-StringObject.md +++ b/docs/classes/YooKassa-Helpers-StringObject.md @@ -78,11 +78,11 @@ public __toString() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-TypeCast.md b/docs/classes/YooKassa-Helpers-TypeCast.md index 6e5cc512..49a32f3f 100644 --- a/docs/classes/YooKassa-Helpers-TypeCast.md +++ b/docs/classes/YooKassa-Helpers-TypeCast.md @@ -157,11 +157,11 @@ Static public castToDateTime(string|int|\DateTime $value) : \DateTime|null ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-UUID.md b/docs/classes/YooKassa-Helpers-UUID.md index 7076af1f..31bd14da 100644 --- a/docs/classes/YooKassa-Helpers-UUID.md +++ b/docs/classes/YooKassa-Helpers-UUID.md @@ -17,7 +17,7 @@ --- ### Details * File: [lib/Helpers/UUID.php](../../lib/Helpers/UUID.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * \YooKassa\Helpers\UUID @@ -52,11 +52,11 @@ Static public v4() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Airline.md b/docs/classes/YooKassa-Model-Airline.md index 8f4ad1a7..418aa8f3 100644 --- a/docs/classes/YooKassa-Model-Airline.md +++ b/docs/classes/YooKassa-Model-Airline.md @@ -39,12 +39,12 @@ | public | [getLegs()](../classes/YooKassa-Model-Airline.md#method_getLegs) | | Список объектов-контейнеров с данными о маршруте | | public | [getPassengers()](../classes/YooKassa-Model-Airline.md#method_getPassengers) | | Список объектов-контейнеров с данными пассажиров | | public | [getTicketNumber()](../classes/YooKassa-Model-Airline.md#method_getTicketNumber) | | Уникальный номер билета. Обязателен на этапе подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Model-Airline.md#method_notEmpty) | | Првоерка на наличие данных | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setBookingReference()](../classes/YooKassa-Model-Airline.md#method_setBookingReference) | | Устанавливает номер бронирования. Обязателен на этапе создания платежа. | | public | [setLegs()](../classes/YooKassa-Model-Airline.md#method_setLegs) | | Устанавливает список объектов-контейнеров с данными о маршруте | | public | [setPassengers()](../classes/YooKassa-Model-Airline.md#method_setPassengers) | | Устанавливает список объектов-контейнеров с данными пассажиров | @@ -71,7 +71,7 @@ Номер бронирования. Обязателен на этапе создания платежа -**Type:** string +**Type:** string **Details:** @@ -83,7 +83,7 @@ Номер бронирования. Обязателен на этапе создания платежа -**Type:** string +**Type:** string **Details:** @@ -95,7 +95,7 @@ Список маршрутов -**Type:** Leg[] +**Type:** Leg[] **Details:** @@ -107,7 +107,7 @@ Список пассажиров -**Type:** PassengerInterface[] +**Type:** PassengerInterface[] **Details:** @@ -119,7 +119,7 @@ Уникальный номер билета. Обязателен на этапе подтверждения платежа -**Type:** string +**Type:** string **Details:** @@ -131,7 +131,7 @@ Уникальный номер билета. Обязателен на этапе подтверждения платежа -**Type:** string +**Type:** string **Details:** @@ -405,20 +405,16 @@ public getTicketNumber() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -439,92 +435,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -661,11 +641,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AirlineInterface.md b/docs/classes/YooKassa-Model-AirlineInterface.md index 10108e99..2068b44f 100644 --- a/docs/classes/YooKassa-Model-AirlineInterface.md +++ b/docs/classes/YooKassa-Model-AirlineInterface.md @@ -19,7 +19,7 @@ --- ### Details * File: [lib/Model/AirlineInterface.php](../../lib/Model/AirlineInterface.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -103,11 +103,11 @@ public getLegs() : \YooKassa\Model\LegInterface[] ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AmountInterface.md b/docs/classes/YooKassa-Model-AmountInterface.md index 680b405f..9a3c8177 100644 --- a/docs/classes/YooKassa-Model-AmountInterface.md +++ b/docs/classes/YooKassa-Model-AmountInterface.md @@ -20,6 +20,7 @@ Interface AmountInterface | public | [getValue()](../classes/YooKassa-Model-AmountInterface.md#method_getValue) | | Возвращает значение суммы | | public | [setCurrency()](../classes/YooKassa-Model-AmountInterface.md#method_setCurrency) | | Устанавливает код валюты | | public | [setValue()](../classes/YooKassa-Model-AmountInterface.md#method_setValue) | | Устанавливает значение суммы | +| public | [toArray()](../classes/YooKassa-Model-AmountInterface.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | --- ### Details @@ -56,7 +57,7 @@ public getValue() : string #### public setValue() : mixed ```php -public setValue(\YooKassa\Model\numeric $value) : mixed +public setValue(numeric $value) : mixed ``` **Summary** @@ -69,7 +70,7 @@ public setValue(\YooKassa\Model\numeric $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\numeric | value | Сумма | +| numeric | value | Сумма | **Returns:** mixed - @@ -130,6 +131,23 @@ public setCurrency(string $value) : mixed **Returns:** mixed - + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + --- @@ -142,11 +160,11 @@ public setCurrency(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AuthorizationDetails.md b/docs/classes/YooKassa-Model-AuthorizationDetails.md index fa854b5e..cdf6f238 100644 --- a/docs/classes/YooKassa-Model-AuthorizationDetails.md +++ b/docs/classes/YooKassa-Model-AuthorizationDetails.md @@ -33,11 +33,11 @@ AuthorizationDetails - Данные об авторизации платежа | public | [getAuthCode()](../classes/YooKassa-Model-AuthorizationDetails.md#method_getAuthCode) | | Возвращает код авторизации банковской карты | | public | [getRrn()](../classes/YooKassa-Model-AuthorizationDetails.md#method_getRrn) | | Возвращает уникальный идентификатор транзакции | | public | [getThreeDSecure()](../classes/YooKassa-Model-AuthorizationDetails.md#method_getThreeDSecure) | | Возвращает данные о прохождении пользователем аутентификации по 3‑D Secure | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAuthCode()](../classes/YooKassa-Model-AuthorizationDetails.md#method_setAuthCode) | | Устанавливает код авторизации банковской карты | | public | [setRrn()](../classes/YooKassa-Model-AuthorizationDetails.md#method_setRrn) | | Устанавливает уникальный идентификатор транзакции | | public | [setThreeDSecure()](../classes/YooKassa-Model-AuthorizationDetails.md#method_setThreeDSecure) | | Устанавливает данные о прохождении пользователем аутентификации по 3‑D Secure | @@ -47,7 +47,7 @@ AuthorizationDetails - Данные об авторизации платежа --- ### Details * File: [lib/Model/AuthorizationDetails.php](../../lib/Model/AuthorizationDetails.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\AuthorizationDetails @@ -63,18 +63,19 @@ AuthorizationDetails - Данные об авторизации платежа Код авторизации банковской карты -**Type:** string +**Type:** string **Details:** -#### public $rrn +#### public $rrn : string --- ***Description*** Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента +**Type:** string **Details:** @@ -86,7 +87,7 @@ Retrieval Reference Number — уникальный идентификатор Данные о прохождении пользователем аутентификации по 3‑D Secure -**Type:** ThreeDSecure +**Type:** ThreeDSecure **Details:** @@ -279,109 +280,89 @@ public getThreeDSecure() : \YooKassa\Model\ThreeDSecure|null -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -511,11 +492,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md b/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md index 50850e44..d7d35825 100644 --- a/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md +++ b/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md @@ -97,11 +97,11 @@ public getThreeDSecure() : \YooKassa\Model\ThreeDSecure|null ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-BaseDeal.md b/docs/classes/YooKassa-Model-BaseDeal.md index b0361457..b904d946 100644 --- a/docs/classes/YooKassa-Model-BaseDeal.md +++ b/docs/classes/YooKassa-Model-BaseDeal.md @@ -23,11 +23,11 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setType()](../classes/YooKassa-Model-BaseDeal.md#method_setType) | | Устанавливает тип сделки | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -193,109 +193,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -366,11 +346,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetails.md b/docs/classes/YooKassa-Model-CancellationDetails.md index 4ff3527a..b32786eb 100644 --- a/docs/classes/YooKassa-Model-CancellationDetails.md +++ b/docs/classes/YooKassa-Model-CancellationDetails.md @@ -31,11 +31,11 @@ CancellationDetails - Комментарий к отмене платежа | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getParty()](../classes/YooKassa-Model-CancellationDetails.md#method_getParty) | | Возвращает участника процесса платежа, который принял решение об отмене транзакции | | public | [getReason()](../classes/YooKassa-Model-CancellationDetails.md#method_getReason) | | Возвращает причину отмены платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setParty()](../classes/YooKassa-Model-CancellationDetails.md#method_setParty) | | Устанавливает участника процесса платежа, который принял решение об отмене транзакции | | public | [setReason()](../classes/YooKassa-Model-CancellationDetails.md#method_setReason) | | Устанавливает причину отмены платежа | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -44,7 +44,7 @@ CancellationDetails - Комментарий к отмене платежа --- ### Details * File: [lib/Model/CancellationDetails.php](../../lib/Model/CancellationDetails.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\CancellationDetails @@ -60,7 +60,7 @@ CancellationDetails - Комментарий к отмене платежа Инициатор отмены платежа -**Type:** string +**Type:** string **Details:** @@ -72,7 +72,7 @@ CancellationDetails - Комментарий к отмене платежа Причина отмены платежа -**Type:** string +**Type:** string **Details:** @@ -249,109 +249,89 @@ public getReason() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -444,11 +424,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsInterface.md b/docs/classes/YooKassa-Model-CancellationDetailsInterface.md index 313f6d06..5c5890e8 100644 --- a/docs/classes/YooKassa-Model-CancellationDetailsInterface.md +++ b/docs/classes/YooKassa-Model-CancellationDetailsInterface.md @@ -78,11 +78,11 @@ public getReason() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md b/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md index 7d318c84..5d1e1434 100644 --- a/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md +++ b/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md @@ -33,7 +33,7 @@ CancellationDetailsPartyCode - Возможные инициаторы отме --- ### Details * File: [lib/Model/CancellationDetailsPartyCode.php](../../lib/Model/CancellationDetailsPartyCode.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\CancellationDetailsPartyCode @@ -73,7 +73,7 @@ PAYMENT_NETWORK = 'payment_network' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -148,11 +148,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md b/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md index 160de42b..28995bac 100644 --- a/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md +++ b/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md @@ -50,7 +50,7 @@ CancellationDetailsReasonCode - Возможные причины отмены --- ### Details * File: [lib/Model/CancellationDetailsReasonCode.php](../../lib/Model/CancellationDetailsReasonCode.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\CancellationDetailsReasonCode @@ -250,7 +250,7 @@ UNSUPPORTED_MOBILE_OPERATOR = 'unsupported_mobile_operator' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -325,11 +325,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md b/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md index 50f11e6e..44d1d6e5 100644 --- a/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md +++ b/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md @@ -32,11 +32,11 @@ | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | | protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | @@ -44,7 +44,7 @@ --- ### Details * File: [lib/Model/Confirmation/AbstractConfirmation.php](../../lib/Model/Confirmation/AbstractConfirmation.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Confirmation\AbstractConfirmation @@ -54,7 +54,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** @@ -196,10 +196,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -209,14 +209,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -226,14 +226,14 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationUrl() +#### public getConfirmationUrl() : string ```php -public getConfirmationUrl() +public getConfirmationUrl() : string ``` **Description** @@ -243,7 +243,7 @@ public getConfirmationUrl() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -264,109 +264,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -437,11 +417,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md index 06e47592..76fb367b 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md @@ -32,11 +32,11 @@ | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | | protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | @@ -55,7 +55,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -189,10 +189,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -202,14 +202,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -219,14 +219,14 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationUrl() +#### public getConfirmationUrl() : string ```php -public getConfirmationUrl() +public getConfirmationUrl() : string ``` **Description** @@ -236,7 +236,7 @@ public getConfirmationUrl() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -257,109 +257,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -430,11 +410,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md index 48d153f7..052adbd1 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md @@ -34,11 +34,11 @@ | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setConfirmationToken()](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md#method_setConfirmationToken) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -47,7 +47,7 @@ --- ### Details * File: [lib/Model/Confirmation/ConfirmationEmbedded.php](../../lib/Model/Confirmation/ConfirmationEmbedded.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -62,7 +62,7 @@ Токен для checkout.js -**Type:** string +**Type:** string **Details:** @@ -70,7 +70,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -204,10 +204,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -217,7 +217,7 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -234,10 +234,10 @@ public getConfirmationToken() : string -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -247,14 +247,14 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationUrl() +#### public getConfirmationUrl() : string ```php -public getConfirmationUrl() +public getConfirmationUrl() : string ``` **Description** @@ -264,7 +264,7 @@ public getConfirmationUrl() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -285,109 +285,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -476,11 +456,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md index ea82e920..b3b40e39 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md @@ -33,11 +33,11 @@ | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | | protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | @@ -56,7 +56,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -190,10 +190,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -203,14 +203,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -220,14 +220,14 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationUrl() +#### public getConfirmationUrl() : string ```php -public getConfirmationUrl() +public getConfirmationUrl() : string ``` **Description** @@ -237,7 +237,7 @@ public getConfirmationUrl() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -258,109 +258,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -431,11 +411,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md index 6ee1f750..6a7888f3 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md @@ -84,11 +84,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md index 48c3c877..f04dd03d 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md @@ -35,15 +35,15 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | -| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md#method_getConfirmationUrl) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md#method_getReturnUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md#method_setConfirmationUrl) | | | | public | [setReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationMobileApplication.md#method_setReturnUrl) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -53,7 +53,7 @@ --- ### Details * File: [lib/Model/Confirmation/ConfirmationMobileApplication.php](../../lib/Model/Confirmation/ConfirmationMobileApplication.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -68,7 +68,7 @@ URL на который необходимо перенаправить плательщика для подтверждения оплаты -**Type:** string +**Type:** string **Details:** @@ -80,7 +80,7 @@ URL на который необходимо перенаправить плат URL на который необходимо перенаправить плательщика для подтверждения оплаты -**Type:** string +**Type:** string **Details:** @@ -92,7 +92,7 @@ URL на который необходимо перенаправить плат URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера -**Type:** string +**Type:** string **Details:** @@ -104,7 +104,7 @@ URL на который вернется плательщик после под URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера -**Type:** string +**Type:** string **Details:** @@ -112,7 +112,7 @@ URL на который вернется плательщик после под #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -251,10 +251,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -264,14 +264,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -281,24 +281,7 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - - - - -#### public getConfirmationUrl() - -```php -public getConfirmationUrl() -``` - -**Description** - -Для ConfirmationRedirect - -**Details:** -* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) - -**Returns:** - +**Returns:** string - @@ -314,6 +297,23 @@ public getConfirmationUrl() : string **Returns:** string - URL на который необходимо перенаправить плательщика для подтверждения оплаты. + +#### public getConfirmationUrl() : string + +```php +public getConfirmationUrl() : string +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + #### public getReturnUrl() : string @@ -345,109 +345,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -554,11 +534,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md index 7753b70a..79f85c26 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md @@ -35,11 +35,11 @@ | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setConfirmationData()](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#method_setConfirmationData) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -48,7 +48,7 @@ --- ### Details * File: [lib/Model/Confirmation/ConfirmationQr.php](../../lib/Model/Confirmation/ConfirmationQr.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -63,7 +63,7 @@ URL для создания QR-кода -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ URL для создания QR-кода URL для создания QR-кода -**Type:** string +**Type:** string **Details:** @@ -83,7 +83,7 @@ URL для создания QR-кода #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -230,10 +230,10 @@ public getConfirmationData() : string -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -243,14 +243,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -260,14 +260,14 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationUrl() +#### public getConfirmationUrl() : string ```php -public getConfirmationUrl() +public getConfirmationUrl() : string ``` **Description** @@ -277,7 +277,7 @@ public getConfirmationUrl() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - @@ -298,109 +298,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -489,11 +469,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md index ab8a71fd..ad626581 100644 --- a/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md @@ -36,16 +36,16 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | | public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | -| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getConfirmationUrl) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | | public | [getEnforce()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getEnforce) | | | | public | [getReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getReturnUrl) | | | | public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setConfirmationUrl) | | | | public | [setEnforce()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setEnforce) | | | | public | [setReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setReturnUrl) | | | @@ -56,7 +56,7 @@ --- ### Details * File: [lib/Model/Confirmation/ConfirmationRedirect.php](../../lib/Model/Confirmation/ConfirmationRedirect.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -71,7 +71,7 @@ URL на который необходимо перенаправить плательщика для подтверждения оплаты -**Type:** string +**Type:** string **Details:** @@ -83,7 +83,7 @@ URL на который необходимо перенаправить плат URL на который необходимо перенаправить плательщика для подтверждения оплаты -**Type:** string +**Type:** string **Details:** @@ -96,7 +96,7 @@ URL на который необходимо перенаправить плат Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы -**Type:** bool +**Type:** bool **Details:** @@ -108,7 +108,7 @@ URL на который необходимо перенаправить плат URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера -**Type:** string +**Type:** string **Details:** @@ -120,7 +120,7 @@ URL на который вернется плательщик после под URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера -**Type:** string +**Type:** string **Details:** @@ -128,7 +128,7 @@ URL на который вернется плательщик после под #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) @@ -262,10 +262,10 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getConfirmationData() +#### public getConfirmationData() : string ```php -public getConfirmationData() +public getConfirmationData() : string ``` **Description** @@ -275,14 +275,14 @@ public getConfirmationData() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - +**Returns:** string - -#### public getConfirmationToken() +#### public getConfirmationToken() : string ```php -public getConfirmationToken() +public getConfirmationToken() : string ``` **Description** @@ -292,24 +292,7 @@ public getConfirmationToken() **Details:** * Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) -**Returns:** - - - - -#### public getConfirmationUrl() - -```php -public getConfirmationUrl() -``` - -**Description** - -Для ConfirmationRedirect - -**Details:** -* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) - -**Returns:** - +**Returns:** string - @@ -325,6 +308,23 @@ public getConfirmationUrl() : string **Returns:** string - URL на который необходимо перенаправить плательщика для подтверждения оплаты. + +#### public getConfirmationUrl() : string + +```php +public getConfirmationUrl() : string +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + #### public getEnforce() : bool @@ -370,109 +370,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -597,11 +577,11 @@ protected setType(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md index 08a4fc98..89f380dd 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md @@ -30,20 +30,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details * File: [lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php](../../lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes @@ -53,7 +53,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** @@ -221,109 +221,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -362,24 +342,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -397,6 +359,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -408,11 +388,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md index 0736f305..dfb897fc 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md @@ -30,15 +30,15 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details @@ -54,7 +54,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -214,109 +214,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -355,24 +335,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -390,6 +352,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -401,11 +381,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md index 6557ab65..90e1af64 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md @@ -30,20 +30,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details * File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -54,7 +54,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -214,109 +214,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -355,24 +335,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -390,6 +352,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -401,11 +381,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md index 7cb193ec..bdfdfeab 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md @@ -31,15 +31,15 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details @@ -55,7 +55,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -215,109 +215,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -356,24 +336,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -391,6 +353,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -402,11 +382,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md index f73350b9..fee3a885 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md @@ -76,11 +76,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md index 0df7d81b..9d17fdb9 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md @@ -33,21 +33,21 @@ | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md#method_getReturnUrl) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [setReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesMobileApplication.md#method_setReturnUrl) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details * File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -62,7 +62,7 @@ URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. -**Type:** string +**Type:** string **Details:** @@ -74,7 +74,7 @@ URL на который вернется плательщик после под URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. -**Type:** string +**Type:** string **Details:** @@ -82,7 +82,7 @@ URL на который вернется плательщик после под #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -260,109 +260,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -419,24 +399,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -454,6 +416,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -465,11 +445,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md index 197dbd4d..c853e793 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md @@ -30,20 +30,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details * File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -54,7 +54,7 @@ #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -214,109 +214,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -355,24 +335,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -390,6 +352,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -401,11 +381,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md index b4a3a244..9772ad88 100644 --- a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md @@ -35,22 +35,22 @@ | public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | | public | [getReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_getReturnUrl) | | | | public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setEnforce()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_setEnforce) | | | | public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | | public | [setReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_setReturnUrl) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setType) | | | --- ### Details * File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -66,7 +66,7 @@ Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы. -**Type:** bool +**Type:** bool **Details:** @@ -78,7 +78,7 @@ URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. -**Type:** string +**Type:** string **Details:** @@ -90,7 +90,7 @@ URL на который вернется плательщик после под URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. -**Type:** string +**Type:** string **Details:** @@ -98,7 +98,7 @@ URL на который вернется плательщик после под #### public $type : string --- -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) @@ -285,109 +285,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -462,24 +442,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Details:** -* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -497,6 +459,24 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + --- @@ -508,11 +488,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationType.md b/docs/classes/YooKassa-Model-ConfirmationType.md index 56daef6f..408f529f 100644 --- a/docs/classes/YooKassa-Model-ConfirmationType.md +++ b/docs/classes/YooKassa-Model-ConfirmationType.md @@ -6,26 +6,27 @@ **Summary:** ConfirmationType - Тип пользовательского процесса подтверждения платежа -|Код|Описание| ---- | --- -|redirect|Необходимо направить плательщика на страницу партнера| -|external|Необходимо ождать пока плательщик самостоятельно подтвердит платеж| -|code_verification|Необходимо получить одноразовый код от плательщика для подтверждения платежа| -|embedded|Необходимо получить токен для checkout.js| -|qr|Необходимо получить QR-код| -|mobile_application|необходимо совершить действия в мобильном приложении| +**Description:** + +Возможные значения: +- `redirect` - Необходимо направить плательщика на страницу партнера +- `external` - Для подтверждения платежа пользователю необходимо совершить действия во внешней системе (например, ответить на смс) +- `code_verification` - Необходимо получить одноразовый код от плательщика для подтверждения платежа +- `embedded` - Необходимо получить токен для checkout.js +- `qr` - Необходимо получить QR-код +- `mobile_application` - Необходимо совершить действия в мобильном приложении --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [REDIRECT](../classes/YooKassa-Model-ConfirmationType.md#constant_REDIRECT) | | | -| public | [EXTERNAL](../classes/YooKassa-Model-ConfirmationType.md#constant_EXTERNAL) | | | -| public | [CODE_VERIFICATION](../classes/YooKassa-Model-ConfirmationType.md#constant_CODE_VERIFICATION) | | | -| public | [EMBEDDED](../classes/YooKassa-Model-ConfirmationType.md#constant_EMBEDDED) | | | -| public | [QR](../classes/YooKassa-Model-ConfirmationType.md#constant_QR) | | | -| public | [MOBILE_APPLICATION](../classes/YooKassa-Model-ConfirmationType.md#constant_MOBILE_APPLICATION) | | | +| public | [REDIRECT](../classes/YooKassa-Model-ConfirmationType.md#constant_REDIRECT) | | Необходимо направить плательщика на страницу партнера | +| public | [EXTERNAL](../classes/YooKassa-Model-ConfirmationType.md#constant_EXTERNAL) | | Для подтверждения платежа пользователю необходимо совершить действия во внешней системе (например, ответить на смс) | +| public | [CODE_VERIFICATION](../classes/YooKassa-Model-ConfirmationType.md#constant_CODE_VERIFICATION) | *deprecated* | Необходимо ждать пока плательщик самостоятельно подтвердит платеж | +| public | [EMBEDDED](../classes/YooKassa-Model-ConfirmationType.md#constant_EMBEDDED) | | Необходимо получить одноразовый код от плательщика для подтверждения платежа | +| public | [QR](../classes/YooKassa-Model-ConfirmationType.md#constant_QR) | | Необходимо получить QR-код | +| public | [MOBILE_APPLICATION](../classes/YooKassa-Model-ConfirmationType.md#constant_MOBILE_APPLICATION) | | Необходимо совершить действия в мобильном приложении | --- ### Properties @@ -44,7 +45,7 @@ ConfirmationType - Тип пользовательского процесса п --- ### Details * File: [lib/Model/ConfirmationType.php](../../lib/Model/ConfirmationType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\ConfirmationType @@ -53,6 +54,8 @@ ConfirmationType - Тип пользовательского процесса п ## Constants ###### REDIRECT +Необходимо направить плательщика на страницу партнера + ```php REDIRECT = 'redirect' ``` @@ -60,20 +63,28 @@ REDIRECT = 'redirect' ###### EXTERNAL +Для подтверждения платежа пользователю необходимо совершить действия во внешней системе (например, ответить на смс) + ```php EXTERNAL = 'external' ``` -###### CODE_VERIFICATION +###### ~~CODE_VERIFICATION~~ +Необходимо ждать пока плательщик самостоятельно подтвердит платеж + ```php CODE_VERIFICATION = 'code_verification' ``` +**deprecated** +Будет удален в будущих версиях ###### EMBEDDED +Необходимо получить одноразовый код от плательщика для подтверждения платежа + ```php EMBEDDED = 'embedded' ``` @@ -81,6 +92,8 @@ EMBEDDED = 'embedded' ###### QR +Необходимо получить QR-код + ```php QR = 'qr' ``` @@ -88,6 +101,8 @@ QR = 'qr' ###### MOBILE_APPLICATION +Необходимо совершить действия в мобильном приложении + ```php MOBILE_APPLICATION = 'mobile_application' ``` @@ -99,7 +114,7 @@ MOBILE_APPLICATION = 'mobile_application' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -174,11 +189,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CurrencyCode.md b/docs/classes/YooKassa-Model-CurrencyCode.md index 6ce272b7..496718a2 100644 --- a/docs/classes/YooKassa-Model-CurrencyCode.md +++ b/docs/classes/YooKassa-Model-CurrencyCode.md @@ -5,8 +5,12 @@ --- **Summary:** -CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol +CurrencyCode - Код валюты в формате [ISO-4217](https://www.iso.org/iso-4217-currency-codes.md). +**Description:** + +Должен соответствовать валюте субаккаунта (`recipient.gateway_id`), если вы разделяете потоки платежей, +и валюте аккаунта (shopId в [личном кабинете](https://yookassa.ru/my)), если не разделяете. --- ### Constants @@ -19,6 +23,11 @@ CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol | public | [CNY](../classes/YooKassa-Model-CurrencyCode.md#constant_CNY) | | Китайская йена | | public | [KZT](../classes/YooKassa-Model-CurrencyCode.md#constant_KZT) | | Казахский тенге | | public | [UAH](../classes/YooKassa-Model-CurrencyCode.md#constant_UAH) | | Украинская гривна | +| public | [UZS](../classes/YooKassa-Model-CurrencyCode.md#constant_UZS) | | Узбекский сум | +| public | [_TRY](../classes/YooKassa-Model-CurrencyCode.md#constant__TRY) | | Турецкая лира | +| public | [INR](../classes/YooKassa-Model-CurrencyCode.md#constant_INR) | | Индийская рупия | +| public | [MDL](../classes/YooKassa-Model-CurrencyCode.md#constant_MDL) | | Молдавский лей | +| public | [AZN](../classes/YooKassa-Model-CurrencyCode.md#constant_AZN) | | Азербайджанский манат | --- ### Properties @@ -37,11 +46,17 @@ CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol --- ### Details * File: [lib/Model/CurrencyCode.php](../../lib/Model/CurrencyCode.php) -* Package: Default +* Package: YooKassa\Model * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\CurrencyCode +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + --- ## Constants @@ -107,13 +122,58 @@ UAH = 'UAH' ``` + +###### UZS +Узбекский сум + +```php +UZS = 'UZS' +``` + + + +###### _TRY +Турецкая лира + +```php +_TRY = 'TRY' +``` + + + +###### INR +Индийская рупия + +```php +INR = 'INR' +``` + + + +###### MDL +Молдавский лей + +```php +MDL = 'MDL' +``` + + + +###### AZN +Азербайджанский манат + +```php +AZN = 'AZN' +``` + + --- ## Properties #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -188,11 +248,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-CaptureDealData.md b/docs/classes/YooKassa-Model-Deal-CaptureDealData.md index cd452151..2d084098 100644 --- a/docs/classes/YooKassa-Model-Deal-CaptureDealData.md +++ b/docs/classes/YooKassa-Model-Deal-CaptureDealData.md @@ -30,11 +30,11 @@ Class CaptureDealData | public | [addSettlement()](../classes/YooKassa-Model-Deal-CaptureDealData.md#method_addSettlement) | | Добавляет оплату в чек | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getSettlements()](../classes/YooKassa-Model-Deal-CaptureDealData.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setSettlements()](../classes/YooKassa-Model-Deal-CaptureDealData.md#method_setSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -56,7 +56,7 @@ Class CaptureDealData Данные о распределении денег -**Type:** SettlementPayoutPayment[] +**Type:** SettlementPayoutPayment[] **Details:** @@ -237,109 +237,89 @@ public getSettlements() : \YooKassa\Model\SettlementInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -410,11 +390,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-DealBalanceAmount.md b/docs/classes/YooKassa-Model-Deal-DealBalanceAmount.md index 9cb3f86d..53ec1c3e 100644 --- a/docs/classes/YooKassa-Model-Deal-DealBalanceAmount.md +++ b/docs/classes/YooKassa-Model-Deal-DealBalanceAmount.md @@ -32,11 +32,11 @@ MonetaryAmount - Сумма определенная в валюте | public | [getCurrency()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_getCurrency) | | Возвращает валюту | | public | [getIntegerValue()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | | public | [getValue()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_getValue) | | Возвращает значение суммы | -| public | [jsonSerialize()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCurrency()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_setCurrency) | | Устанавливает код валюты | | public | [setValue()](../classes/YooKassa-Model-Deal-DealBalanceAmount.md#method_setValue) | | Устанавливает сумму | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -61,7 +61,7 @@ MonetaryAmount - Сумма определенная в валюте Код валюты -**Type:** string +**Type:** string **Details:** @@ -73,7 +73,7 @@ MonetaryAmount - Сумма определенная в валюте Сумма -**Type:** int +**Type:** int **Details:** @@ -85,7 +85,7 @@ MonetaryAmount - Сумма определенная в валюте #### public __construct() : mixed ```php -public __construct(array|\YooKassa\Model\Deal\numeric|null $value = null, string|null $currency = null) : mixed +public __construct(array|numeric-string|int|float|null $value = null, string|null $currency = null) : mixed ``` **Summary** @@ -98,7 +98,7 @@ MonetaryAmount constructor. ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array OR \YooKassa\Model\Deal\numeric OR null | value | Сумма | +| array OR numeric-string OR int OR float OR null | value | Сумма | | string OR null | currency | Код валюты | **Returns:** mixed - @@ -273,10 +273,6 @@ public getValue() : string public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\Deal\DealBalanceAmount](../classes/YooKassa-Model-Deal-DealBalanceAmount.md) @@ -284,92 +280,76 @@ public jsonSerialize() : array -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -476,11 +456,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-DealStatus.md b/docs/classes/YooKassa-Model-Deal-DealStatus.md index 9e96308f..7a09c98f 100644 --- a/docs/classes/YooKassa-Model-Deal-DealStatus.md +++ b/docs/classes/YooKassa-Model-Deal-DealStatus.md @@ -64,7 +64,7 @@ CLOSED = 'closed' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -139,11 +139,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-DealType.md b/docs/classes/YooKassa-Model-Deal-DealType.md index 3b1126b5..c8505b38 100644 --- a/docs/classes/YooKassa-Model-Deal-DealType.md +++ b/docs/classes/YooKassa-Model-Deal-DealType.md @@ -31,7 +31,7 @@ --- ### Details * File: [lib/Model/Deal/DealType.php](../../lib/Model/Deal/DealType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Deal\DealType @@ -53,7 +53,7 @@ SAFE_DEAL = 'safe_deal' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -128,11 +128,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-FeeMoment.md b/docs/classes/YooKassa-Model-Deal-FeeMoment.md index 69626a25..7054c5db 100644 --- a/docs/classes/YooKassa-Model-Deal-FeeMoment.md +++ b/docs/classes/YooKassa-Model-Deal-FeeMoment.md @@ -63,7 +63,7 @@ DEAL_CLOSED = 'deal_closed' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -138,11 +138,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-PaymentDealInfo.md b/docs/classes/YooKassa-Model-Deal-PaymentDealInfo.md index 65cf37b6..35308e31 100644 --- a/docs/classes/YooKassa-Model-Deal-PaymentDealInfo.md +++ b/docs/classes/YooKassa-Model-Deal-PaymentDealInfo.md @@ -32,11 +32,11 @@ Class PaymentDealInfo | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getId()](../classes/YooKassa-Model-Deal-PaymentDealInfo.md#method_getId) | | Возвращает Id сделки | | public | [getSettlements()](../classes/YooKassa-Model-Deal-PaymentDealInfo.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-Deal-PaymentDealInfo.md#method_setId) | | Устанавливает Id сделки | | public | [setSettlements()](../classes/YooKassa-Model-Deal-PaymentDealInfo.md#method_setSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -59,7 +59,7 @@ Class PaymentDealInfo Идентификатор сделки -**Type:** string +**Type:** string **Details:** @@ -71,7 +71,7 @@ Class PaymentDealInfo Данные о распределении денег -**Type:** SettlementPayoutPayment[] +**Type:** SettlementPayoutPayment[] **Details:** @@ -269,109 +269,89 @@ public getSettlements() : \YooKassa\Model\SettlementInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -464,11 +444,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-PayoutDealInfo.md b/docs/classes/YooKassa-Model-Deal-PayoutDealInfo.md index 17304ed3..8fbdeb04 100644 --- a/docs/classes/YooKassa-Model-Deal-PayoutDealInfo.md +++ b/docs/classes/YooKassa-Model-Deal-PayoutDealInfo.md @@ -29,11 +29,11 @@ Class PayoutDealInfo | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getId()](../classes/YooKassa-Model-Deal-PayoutDealInfo.md#method_getId) | | Возвращает Id сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-Deal-PayoutDealInfo.md#method_setId) | | Устанавливает Id сделки | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -55,7 +55,7 @@ Class PayoutDealInfo Идентификатор сделки -**Type:** string +**Type:** string **Details:** @@ -214,109 +214,89 @@ public getId() : mixed -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -387,11 +367,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-RefundDealData.md b/docs/classes/YooKassa-Model-Deal-RefundDealData.md index e4c00f31..2adf421a 100644 --- a/docs/classes/YooKassa-Model-Deal-RefundDealData.md +++ b/docs/classes/YooKassa-Model-Deal-RefundDealData.md @@ -31,11 +31,11 @@ Class PaymentDealInfo | public | [addRefundSettlement()](../classes/YooKassa-Model-Deal-RefundDealData.md#method_addRefundSettlement) | | Добавляет оплату в чек | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getRefundSettlements()](../classes/YooKassa-Model-Deal-RefundDealData.md#method_getRefundSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setRefundSettlements()](../classes/YooKassa-Model-Deal-RefundDealData.md#method_setRefundSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -57,7 +57,7 @@ Class PaymentDealInfo Данные о распределении денег -**Type:** SettlementPayoutRefund[] +**Type:** SettlementPayoutRefund[] **Details:** @@ -69,7 +69,7 @@ Class PaymentDealInfo Данные о распределении денег -**Type:** SettlementPayoutRefund[] +**Type:** SettlementPayoutRefund[] **Details:** @@ -250,109 +250,89 @@ public getRefundSettlements() : \YooKassa\Model\SettlementInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -423,11 +403,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-RefundDealInfo.md b/docs/classes/YooKassa-Model-Deal-RefundDealInfo.md index 7cb3eaad..70d7d3ab 100644 --- a/docs/classes/YooKassa-Model-Deal-RefundDealInfo.md +++ b/docs/classes/YooKassa-Model-Deal-RefundDealInfo.md @@ -33,11 +33,11 @@ Class PaymentDealInfo | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getId()](../classes/YooKassa-Model-Deal-RefundDealInfo.md#method_getId) | | Возвращает Id сделки | | public | [getRefundSettlements()](../classes/YooKassa-Model-Deal-RefundDealInfo.md#method_getRefundSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-Deal-RefundDealInfo.md#method_setId) | | Устанавливает Id сделки | | public | [setRefundSettlements()](../classes/YooKassa-Model-Deal-RefundDealInfo.md#method_setRefundSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -60,7 +60,7 @@ Class PaymentDealInfo Идентификатор сделки -**Type:** string +**Type:** string **Details:** @@ -72,7 +72,7 @@ Class PaymentDealInfo Данные о распределении денег -**Type:** SettlementPayoutRefund[] +**Type:** SettlementPayoutRefund[] **Details:** @@ -84,7 +84,7 @@ Class PaymentDealInfo Данные о распределении денег -**Type:** SettlementPayoutRefund[] +**Type:** SettlementPayoutRefund[] **Details:** @@ -282,109 +282,89 @@ public getRefundSettlements() : \YooKassa\Model\SettlementInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -477,11 +457,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-SettlementPayoutPayment.md b/docs/classes/YooKassa-Model-Deal-SettlementPayoutPayment.md index cc509fc2..4d506633 100644 --- a/docs/classes/YooKassa-Model-Deal-SettlementPayoutPayment.md +++ b/docs/classes/YooKassa-Model-Deal-SettlementPayoutPayment.md @@ -31,11 +31,11 @@ Class SettlementPayoutPayment | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAmount()](../classes/YooKassa-Model-Deal-SettlementPayoutPayment.md#method_getAmount) | | Возвращает размер оплаты | | public | [getType()](../classes/YooKassa-Model-Deal-SettlementPayoutPayment.md#method_getType) | | Возвращает тип операции (payout - выплата продавцу) | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Deal-SettlementPayoutPayment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setType()](../classes/YooKassa-Model-Deal-SettlementPayoutPayment.md#method_setType) | | Устанавливает вид оплаты в чеке | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -60,7 +60,7 @@ Class SettlementPayoutPayment Размер оплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -72,7 +72,7 @@ Class SettlementPayoutPayment Вид оплаты в чеке -**Type:** string +**Type:** string **Details:** @@ -248,109 +248,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -443,11 +423,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-SettlementPayoutPaymentType.md b/docs/classes/YooKassa-Model-Deal-SettlementPayoutPaymentType.md index 689f2e28..9b13721c 100644 --- a/docs/classes/YooKassa-Model-Deal-SettlementPayoutPaymentType.md +++ b/docs/classes/YooKassa-Model-Deal-SettlementPayoutPaymentType.md @@ -31,7 +31,7 @@ --- ### Details * File: [lib/Model/Deal/SettlementPayoutPaymentType.php](../../lib/Model/Deal/SettlementPayoutPaymentType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Deal\SettlementPayoutPaymentType @@ -51,7 +51,7 @@ PAYOUT = 'payout' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -126,11 +126,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Deal-SettlementPayoutRefund.md b/docs/classes/YooKassa-Model-Deal-SettlementPayoutRefund.md index f88f363e..1b9344f9 100644 --- a/docs/classes/YooKassa-Model-Deal-SettlementPayoutRefund.md +++ b/docs/classes/YooKassa-Model-Deal-SettlementPayoutRefund.md @@ -31,11 +31,11 @@ Class SettlementPayoutRefund | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAmount()](../classes/YooKassa-Model-Deal-SettlementPayoutRefund.md#method_getAmount) | | Возвращает размер оплаты | | public | [getType()](../classes/YooKassa-Model-Deal-SettlementPayoutRefund.md#method_getType) | | Возвращает тип операции (payout - выплата продавцу) | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Deal-SettlementPayoutRefund.md#method_setAmount) | | Устанавливает сумму, на которую необходимо уменьшить вознаграждение продавца. | | public | [setType()](../classes/YooKassa-Model-Deal-SettlementPayoutRefund.md#method_setType) | | Устанавливает вид оплаты в чеке | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -60,7 +60,7 @@ Class SettlementPayoutRefund Размер оплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -72,7 +72,7 @@ Class SettlementPayoutRefund Вид оплаты в чеке -**Type:** string +**Type:** string **Details:** @@ -248,109 +248,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -447,11 +427,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-DealInterface.md b/docs/classes/YooKassa-Model-DealInterface.md index dbf4f206..cebc290d 100644 --- a/docs/classes/YooKassa-Model-DealInterface.md +++ b/docs/classes/YooKassa-Model-DealInterface.md @@ -253,11 +253,11 @@ public getTest() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-FraudData.md b/docs/classes/YooKassa-Model-FraudData.md new file mode 100644 index 00000000..d3b0b10f --- /dev/null +++ b/docs/classes/YooKassa-Model-FraudData.md @@ -0,0 +1,399 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\FraudData +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс, представляющий модель FraudData. + +**Description:** + +Информация для проверки операции на мошенничество + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$topped_up_phone](../classes/YooKassa-Model-FraudData.md#property_topped_up_phone) | | Номер телефона для пополнения | +| public | [$toppedUpPhone](../classes/YooKassa-Model-FraudData.md#property_toppedUpPhone) | | Номер телефона для пополнения | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getToppedUpPhone()](../classes/YooKassa-Model-FraudData.md#method_getToppedUpPhone) | | Возвращает номер телефона для пополнения. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setToppedUpPhone()](../classes/YooKassa-Model-FraudData.md#method_setToppedUpPhone) | | Устанавливает номер телефона для пополнения. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/FraudData.php](../../lib/Model/FraudData.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\FraudData + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $topped_up_phone : string +--- +***Description*** + +Номер телефона для пополнения + +**Type:** string + +**Details:** + + + +#### public $toppedUpPhone : string +--- +***Description*** + +Номер телефона для пополнения + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getToppedUpPhone() : string|null + +```php +public getToppedUpPhone() : string|null +``` + +**Summary** + +Возвращает номер телефона для пополнения. + +**Details:** +* Inherited From: [\YooKassa\Model\FraudData](../classes/YooKassa-Model-FraudData.md) + +**Returns:** string|null - Номер телефона для пополнения + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setToppedUpPhone() : \YooKassa\Model\FraudData + +```php +public setToppedUpPhone(string|null $topped_up_phone = null) : \YooKassa\Model\FraudData +``` + +**Summary** + +Устанавливает номер телефона для пополнения. + +**Details:** +* Inherited From: [\YooKassa\Model\FraudData](../classes/YooKassa-Model-FraudData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | topped_up_phone | Номер телефона для пополнения | + +**Returns:** \YooKassa\Model\FraudData - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Leg.md b/docs/classes/YooKassa-Model-Leg.md index 8ca294a2..b431bc5b 100644 --- a/docs/classes/YooKassa-Model-Leg.md +++ b/docs/classes/YooKassa-Model-Leg.md @@ -38,11 +38,11 @@ | public | [getDepartureAirport()](../classes/YooKassa-Model-Leg.md#method_getDepartureAirport) | | Возвращает трёхбуквенный IATA-код аэропорта вылета | | public | [getDepartureDate()](../classes/YooKassa-Model-Leg.md#method_getDepartureDate) | | Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | | public | [getDestinationAirport()](../classes/YooKassa-Model-Leg.md#method_getDestinationAirport) | | Возвращает трёхбуквенный IATA-код аэропорта прилёта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setDepartureAirport()](../classes/YooKassa-Model-Leg.md#method_setDepartureAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта вылета | | public | [setDepartureDate()](../classes/YooKassa-Model-Leg.md#method_setDepartureDate) | | Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | | public | [setDestinationAirport()](../classes/YooKassa-Model-Leg.md#method_setDestinationAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта прилёта | @@ -80,7 +80,7 @@ ISO8601 = 'Y-m-d' Трёхбуквенный IATA-код аэропорта вылета -**Type:** string +**Type:** string **Details:** @@ -92,7 +92,7 @@ ISO8601 = 'Y-m-d' Дата вылета в формате YYYY-MM-DD ISO 8601:2004 -**Type:** string +**Type:** string **Details:** @@ -104,7 +104,7 @@ ISO8601 = 'Y-m-d' Трёхбуквенный IATA-код аэропорта вылета -**Type:** string +**Type:** string **Details:** @@ -116,7 +116,7 @@ ISO8601 = 'Y-m-d' Дата вылета в формате YYYY-MM-DD ISO 8601:2004 -**Type:** string +**Type:** string **Details:** @@ -128,7 +128,7 @@ ISO8601 = 'Y-m-d' Трёхбуквенный IATA-код аэропорта прилёта -**Type:** string +**Type:** string **Details:** @@ -140,7 +140,7 @@ ISO8601 = 'Y-m-d' Трёхбуквенный IATA-код аэропорта прилёта -**Type:** string +**Type:** string **Details:** @@ -345,109 +345,89 @@ public getDestinationAirport() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -579,11 +559,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-LegInterface.md b/docs/classes/YooKassa-Model-LegInterface.md index bc9304de..e4131df9 100644 --- a/docs/classes/YooKassa-Model-LegInterface.md +++ b/docs/classes/YooKassa-Model-LegInterface.md @@ -21,7 +21,7 @@ --- ### Details * File: [lib/Model/LegInterface.php](../../lib/Model/LegInterface.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -154,11 +154,11 @@ public setDepartureDate(\DateTime|string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Locale.md b/docs/classes/YooKassa-Model-Locale.md index da16fa87..bd2f6d65 100644 --- a/docs/classes/YooKassa-Model-Locale.md +++ b/docs/classes/YooKassa-Model-Locale.md @@ -6,18 +6,19 @@ **Summary:** Locale - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь -|Код|Описание| ---- | --- -|ru_RU|Русский| -|en_US|English| +**Description:** + +Возможные значения: +- `ru_RU` - Русский +- `en_US` - English --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [RUSSIAN](../classes/YooKassa-Model-Locale.md#constant_RUSSIAN) | | | -| public | [ENGLISH](../classes/YooKassa-Model-Locale.md#constant_ENGLISH) | | | +| public | [RUSSIAN](../classes/YooKassa-Model-Locale.md#constant_RUSSIAN) | | Русский | +| public | [ENGLISH](../classes/YooKassa-Model-Locale.md#constant_ENGLISH) | | English | --- ### Properties @@ -36,7 +37,7 @@ Locale - Язык интерфейса, писем и смс, которые б --- ### Details * File: [lib/Model/Locale.php](../../lib/Model/Locale.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Locale @@ -45,6 +46,8 @@ Locale - Язык интерфейса, писем и смс, которые б ## Constants ###### RUSSIAN +Русский + ```php RUSSIAN = 'ru_RU' ``` @@ -52,6 +55,8 @@ RUSSIAN = 'ru_RU' ###### ENGLISH +English + ```php ENGLISH = 'en_US' ``` @@ -63,7 +68,7 @@ ENGLISH = 'en_US' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -138,11 +143,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Metadata.md b/docs/classes/YooKassa-Model-Metadata.md index 0027ea86..25c84c63 100644 --- a/docs/classes/YooKassa-Model-Metadata.md +++ b/docs/classes/YooKassa-Model-Metadata.md @@ -25,21 +25,21 @@ Metadata - Метаданные платежа указанные мерчант | public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | | public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | -| public | [count()](../classes/YooKassa-Model-Metadata.md#method_count) | | Возвращает количество метаданных | +| public | [count()](../classes/YooKassa-Model-Metadata.md#method_count) | | | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | -| public | [getIterator()](../classes/YooKassa-Model-Metadata.md#method_getIterator) | | Возвращает объект ArrayIterator для метаданных | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [getIterator()](../classes/YooKassa-Model-Metadata.md#method_getIterator) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Model-Metadata.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | --- ### Details * File: [lib/Model/Metadata.php](../../lib/Model/Metadata.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Metadata @@ -161,20 +161,16 @@ public __unset(string $propertyName) : mixed -#### public count() : int +#### public count() : mixed ```php -public count() : int +public count() : mixed ``` -**Summary** - -Возвращает количество метаданных - **Details:** * Inherited From: [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) -**Returns:** int - +**Returns:** mixed - @@ -200,126 +196,102 @@ public fromArray(array|\Traversable $sourceArray) : mixed -#### public getIterator() : \Iterator +#### public getIterator() : mixed ```php -public getIterator() : \Iterator +public getIterator() : mixed ``` -**Summary** - -Возвращает объект ArrayIterator для метаданных - **Details:** * Inherited From: [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) -**Returns:** \Iterator - +**Returns:** mixed - -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -372,11 +344,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-MonetaryAmount.md b/docs/classes/YooKassa-Model-MonetaryAmount.md index cbd1e749..9b6486d0 100644 --- a/docs/classes/YooKassa-Model-MonetaryAmount.md +++ b/docs/classes/YooKassa-Model-MonetaryAmount.md @@ -33,12 +33,12 @@ MonetaryAmount - Сумма определенная в валюте | public | [getIntegerValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | | public | [getValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_getValue) | | Возвращает значение суммы | | public | [increase()](../classes/YooKassa-Model-MonetaryAmount.md#method_increase) | | Увеличивает сумму на указанное значение | -| public | [jsonSerialize()](../classes/YooKassa-Model-MonetaryAmount.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Model-MonetaryAmount.md#method_jsonSerialize) | | | | public | [multiply()](../classes/YooKassa-Model-MonetaryAmount.md#method_multiply) | | Умножает текущую сумму на указанный коэффициент | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCurrency()](../classes/YooKassa-Model-MonetaryAmount.md#method_setCurrency) | | Устанавливает код валюты | | public | [setValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_setValue) | | Устанавливает сумму | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -63,7 +63,7 @@ MonetaryAmount - Сумма определенная в валюте Код валюты -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ MonetaryAmount - Сумма определенная в валюте Сумма -**Type:** int +**Type:** int **Details:** @@ -87,7 +87,7 @@ MonetaryAmount - Сумма определенная в валюте #### public __construct() : mixed ```php -public __construct(array|\YooKassa\Model\numeric|null $value = null, string|null $currency = null) : mixed +public __construct(array|numeric-string|int|float|null $value = null, string|null $currency = null) : mixed ``` **Summary** @@ -100,7 +100,7 @@ MonetaryAmount constructor. ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array OR \YooKassa\Model\numeric OR null | value | Сумма | +| array OR numeric-string OR int OR float OR null | value | Сумма | | string OR null | currency | Код валюты | **Returns:** mixed - @@ -304,10 +304,6 @@ public increase(int $value) : mixed public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) @@ -344,92 +340,76 @@ public multiply(float $coefficient) : mixed -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -536,11 +516,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-AbstractNotification.md b/docs/classes/YooKassa-Model-Notification-AbstractNotification.md index 01707a89..415f5e18 100644 --- a/docs/classes/YooKassa-Model-Notification-AbstractNotification.md +++ b/docs/classes/YooKassa-Model-Notification-AbstractNotification.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -111,15 +40,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getObject) | | Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** @@ -152,7 +81,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** @@ -359,109 +288,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -482,11 +391,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -511,11 +437,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -540,23 +466,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -568,11 +477,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md b/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md index 48ba3e67..10e5617e 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationCanceled.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о платеже -**Type:** PaymentInterface +**Type:** PaymentInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -289,7 +218,7 @@ public __unset(string $propertyName) : mixed #### public fromArray() : mixed ```php -public fromArray(array $source) : mixed +public fromArray(array $sourceArray) : mixed ``` **Summary** @@ -308,7 +237,7 @@ public fromArray(array $source) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array | source | Ассоциативный массив с информацией об уведомлении | +| array | sourceArray | Ассоциативный массив с информацией об уведомлении | ##### Throws: | Type | Description | @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationDealClosed.md b/docs/classes/YooKassa-Model-Notification-NotificationDealClosed.md index f32218ea..7798e54e 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationDealClosed.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationDealClosed.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationDealClosed.md#method_getObject) | | Возвращает объект с информацией о сделке, уведомление о которой хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о сделке -**Type:** DealInterface +**Type:** DealInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationFactory.md b/docs/classes/YooKassa-Model-Notification-NotificationFactory.md index f39a23f7..2fc103c2 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationFactory.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationFactory.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -135,11 +64,11 @@ public factory(array $data) : \YooKassa\Model\Notification\AbstractNotification ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationInterface.md b/docs/classes/YooKassa-Model-Notification-NotificationInterface.md index 195c1d84..c9306651 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationInterface.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationInterface.md @@ -18,7 +18,7 @@ --- ### Details * File: [lib/Model/Notification/NotificationInterface.php](../../lib/Model/Notification/NotificationInterface.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -99,11 +99,11 @@ public getObject() : \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInte ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationPayoutCanceled.md b/docs/classes/YooKassa-Model-Notification-NotificationPayoutCanceled.md index 70724023..a2f46985 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationPayoutCanceled.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationPayoutCanceled.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationPayoutCanceled.md#method_getObject) | | Возвращает объект с информацией о выплате, уведомление о которой хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о выплате -**Type:** PayoutInterface +**Type:** PayoutInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationPayoutSucceeded.md b/docs/classes/YooKassa-Model-Notification-NotificationPayoutSucceeded.md index f8a66388..41e214b2 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationPayoutSucceeded.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationPayoutSucceeded.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationPayoutSucceeded.md#method_getObject) | | Возвращает объект с информацией о выплате, уведомление о которой хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о выплате -**Type:** PayoutInterface +**Type:** PayoutInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md b/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md index eca3925f..ec36ccfc 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md#method_getObject) | | Возвращает объект с информацией о возврате, уведомление о котором хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о возврате -**Type:** RefundInterface +**Type:** RefundInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md b/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md index 9f1ab41f..d45c0dc3 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md @@ -10,80 +10,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -112,15 +41,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationSucceeded.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -140,7 +69,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -153,7 +82,7 @@ try { Объект с информацией о платеже -**Type:** PaymentInterface +**Type:** PaymentInterface **Details:** @@ -165,7 +94,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -384,109 +313,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -507,11 +416,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -536,11 +462,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -565,23 +491,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -593,11 +502,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md b/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md index 86d1ecca..55c07145 100644 --- a/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md +++ b/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md @@ -15,80 +15,9 @@ --- ### Examples -Пример скрипта обработки уведомления +03-notification.php 3 Пример скрипта обработки уведомления ```php -require_once '../vendor/autoload.php'; - -try { - $source = file_get_contents('php://input'); - $data = json_decode($source, true); - - $factory = new \YooKassa\Model\Notification\NotificationFactory(); - $notificationObject = $factory->factory($data); - $responseObject = $notificationObject->getObject(); - - $client = new \YooKassa\Client(); - - if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { - $someData = array( - 'paymentId' => $responseObject->getId(), - 'paymentStatus' => $responseObject->getStatus(), - ); - // Специфичная логика - // ... - } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { - $someData = array( - 'refundId' => $responseObject->getId(), - 'refundStatus' => $responseObject->getStatus(), - 'paymentId' => $responseObject->getPaymentId(), - ); - // ... - // Специфичная логика - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - - // Специфичная логика - // ... - - $client->setAuth('xxxxxx', 'test_XXXXXXX'); - - // Получим актуальную информацию о платеже - if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { - $paymentStatus = $paymentInfo->getStatus(); - // Специфичная логика - // ... - } else { - header('HTTP/1.1 400 Something went wrong'); - exit(); - } - -} catch (Exception $e) { - header('HTTP/1.1 400 Something went wrong'); - exit(); -} - ``` @@ -117,15 +46,15 @@ try { | public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | | public | [getObject()](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | | public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | -| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setEvent) | | Устанавливает тип события | +| protected | [setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_setType) | | Устанавливает тип уведомления | --- ### Details @@ -145,7 +74,7 @@ try { Тип события -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -158,7 +87,7 @@ try { Объект с информацией о платеже, который можно подтвердить или отменить -**Type:** PaymentInterface +**Type:** PaymentInterface **Details:** @@ -170,7 +99,7 @@ try { Тип уведомления в виде строки -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) @@ -389,109 +318,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -512,11 +421,28 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setEvent() : mixed + +#### protected getUnknownProperties() : array ```php -protected _setEvent(string $value) : mixed +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setEvent() : mixed + +```php +protected setEvent(string $value) : mixed ``` **Summary** @@ -541,11 +467,11 @@ protected _setEvent(string $value) : mixed **Returns:** mixed - - -#### protected _setType() : mixed + +#### protected setType() : mixed ```php -protected _setType(string $value) : mixed +protected setType(string $value) : mixed ``` **Summary** @@ -570,23 +496,6 @@ protected _setType(string $value) : mixed **Returns:** mixed - - -#### protected getUnknownProperties() : array - -```php -protected getUnknownProperties() : array -``` - -**Summary** - -Возвращает массив свойств которые не существуют, но были заданы у объекта - -**Details:** -* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) - -**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами - - --- @@ -598,11 +507,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-NotificationEventType.md b/docs/classes/YooKassa-Model-NotificationEventType.md index 992ca927..a156814f 100644 --- a/docs/classes/YooKassa-Model-NotificationEventType.md +++ b/docs/classes/YooKassa-Model-NotificationEventType.md @@ -6,16 +6,17 @@ **Summary:** NotificationEventType - Тип уведомления -|Код|Описание| ---- | --- -|payment.waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| -|payment.succeeded|Успешно оплачен и подтвержден магазином| -|payment.canceled|Неуспех оплаты или отменен магазином| -|refund.succeeded|Успешный возврат| -|deal.closed|Сделка перешла в статус closed| -|payout.canceled|Выплата перешла в статус canceled| -|payout.succeeded|Выплата перешла в статус succeeded| +**Description:** + +Возможные значения: +- `payment.waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) +- `payment.succeeded` - Успешно оплачен и подтвержден магазином +- `payment.canceled` - Неуспех оплаты или отменен магазином +- `refund.succeeded` - Успешный возврат +- `deal.closed` - Сделка перешла в статус closed +- `payout.canceled` - Выплата перешла в статус canceled +- `payout.succeeded` - Выплата перешла в статус succeeded --- ### Constants @@ -122,7 +123,7 @@ PAYOUT_SUCCEEDED = 'payout.succeeded' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -197,11 +198,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-NotificationType.md b/docs/classes/YooKassa-Model-NotificationType.md index 93253467..1435463b 100644 --- a/docs/classes/YooKassa-Model-NotificationType.md +++ b/docs/classes/YooKassa-Model-NotificationType.md @@ -31,7 +31,7 @@ --- ### Details * File: [lib/Model/NotificationType.php](../../lib/Model/NotificationType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\NotificationType @@ -51,7 +51,7 @@ NOTIFICATION = 'notification' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -126,11 +126,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Passenger.md b/docs/classes/YooKassa-Model-Passenger.md index 69b2c208..d5985fc2 100644 --- a/docs/classes/YooKassa-Model-Passenger.md +++ b/docs/classes/YooKassa-Model-Passenger.md @@ -33,11 +33,11 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getFirstName()](../classes/YooKassa-Model-Passenger.md#method_getFirstName) | | Возвращает имя пассажира | | public | [getLastName()](../classes/YooKassa-Model-Passenger.md#method_getLastName) | | Возвращает фамилию пассажира | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setFirstName()](../classes/YooKassa-Model-Passenger.md#method_setFirstName) | | Устанавливает имя пассажира | | public | [setLastName()](../classes/YooKassa-Model-Passenger.md#method_setLastName) | | Устанавливает фамилию пассажира | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -62,7 +62,7 @@ Имя пассажира -**Type:** string +**Type:** string **Details:** @@ -74,7 +74,7 @@ Имя пассажира -**Type:** string +**Type:** string **Details:** @@ -86,7 +86,7 @@ Фамилия пассажира -**Type:** string +**Type:** string **Details:** @@ -98,7 +98,7 @@ Фамилия пассажира -**Type:** string +**Type:** string **Details:** @@ -282,109 +282,89 @@ public getLastName() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -485,11 +465,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PassengerInterface.md b/docs/classes/YooKassa-Model-PassengerInterface.md index 53523a36..7cceb088 100644 --- a/docs/classes/YooKassa-Model-PassengerInterface.md +++ b/docs/classes/YooKassa-Model-PassengerInterface.md @@ -19,7 +19,7 @@ --- ### Details * File: [lib/Model/PassengerInterface.php](../../lib/Model/PassengerInterface.php) -* Package: \Default +* Package: \YooKassa --- ## Methods @@ -113,11 +113,11 @@ public setLastName(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payment.md b/docs/classes/YooKassa-Model-Payment.md index b2d29148..e85cdb4d 100644 --- a/docs/classes/YooKassa-Model-Payment.md +++ b/docs/classes/YooKassa-Model-Payment.md @@ -85,11 +85,11 @@ Payment - Данные о платеже | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -119,7 +119,7 @@ Payment - Данные о платеже --- ### Details * File: [lib/Model/Payment.php](../../lib/Model/Payment.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Payment @@ -156,7 +156,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -168,7 +168,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** @@ -180,7 +180,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** @@ -192,7 +192,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** @@ -204,7 +204,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** @@ -240,7 +240,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** @@ -276,7 +276,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** @@ -288,7 +288,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** @@ -324,7 +324,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** @@ -336,7 +336,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -348,7 +348,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -360,7 +360,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** @@ -372,7 +372,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** @@ -384,7 +384,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** @@ -396,7 +396,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** @@ -408,7 +408,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** @@ -420,7 +420,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** @@ -432,7 +432,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** @@ -444,7 +444,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** @@ -456,7 +456,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** @@ -468,7 +468,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** @@ -480,7 +480,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -492,7 +492,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -504,7 +504,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** @@ -516,7 +516,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** @@ -528,7 +528,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** @@ -1075,109 +1075,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1803,11 +1783,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md b/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md index b998262d..5a849dd5 100644 --- a/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md +++ b/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/AbstractPaymentData.php](../../lib/Model/PaymentData/AbstractPaymentData.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentData\AbstractPaymentData @@ -55,7 +55,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** @@ -214,109 +214,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -337,28 +317,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -376,6 +334,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -387,11 +367,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md index e92f6ea9..af0b8487 100644 --- a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md @@ -33,11 +33,11 @@ | public | [getAmount()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getAmount) | | Возвращает сумму НДС | | public | [getRate()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getRate) | | Возвращает налоговую ставку НДС | | public | [getType()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getType) | | Возвращает способ расчёта НДС | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setAmount) | | Устанавливает сумму НДС | | public | [setRate()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setRate) | | Устанавливает налоговую ставку НДС | | public | [setType()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setType) | | Устанавливает способ расчёта НДС | @@ -47,7 +47,7 @@ --- ### Details * File: [lib/Model/PaymentData/B2b/Sberbank/VatData.php](../../lib/Model/PaymentData/B2b/Sberbank/VatData.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentData\B2b\Sberbank\VatData @@ -63,7 +63,7 @@ Сумма НДС -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -75,7 +75,7 @@ Данные об НДС в случае, если сумма НДС включена в сумму платежа -**Type:** string +**Type:** string **Details:** @@ -87,7 +87,7 @@ Способ расчёта НДС -**Type:** string +**Type:** string **Details:** @@ -282,109 +282,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -511,11 +491,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md index 3b05e0f0..657d0c20 100644 --- a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md @@ -97,11 +97,11 @@ public getAmount() : \YooKassa\Model\AmountInterface ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md index 7cf3456d..993af4f1 100644 --- a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md @@ -6,13 +6,13 @@ **Summary:** PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС -|Код|Описание| ---- | --- -|7|7%| -|10|10%| -|18|18%| -|20|20%| +**Description:** + +- 7 - 7% +- 10 - 10% +- 18 - 18% +- 20 - 20% --- ### Constants @@ -40,7 +40,7 @@ PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС --- ### Details * File: [lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php](../../lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate @@ -89,7 +89,7 @@ RATE_20 = '20' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -164,11 +164,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md index 00eedd37..d007d73b 100644 --- a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md @@ -6,12 +6,13 @@ **Summary:** PaymentDataB2bSberbankVatDataType - Способ расчёта НДС -|Код|Описание| ---- | --- -|calculated|Сумма НДС включена в сумму платежа| -|mixed|Разные ставки НДС для разных товаров| -|untaxed|Сумма платежа НДС не облагается| +**Description:** + +Возможные значения: +- calculated - Сумма НДС включена в сумму платежа +- mixed - Разные ставки НДС для разных товаров +- untaxed - Сумма платежа НДС не облагается --- ### Constants @@ -38,7 +39,7 @@ PaymentDataB2bSberbankVatDataType - Способ расчёта НДС --- ### Details * File: [lib/Model/PaymentData/B2b/Sberbank/VatDataType.php](../../lib/Model/PaymentData/B2b/Sberbank/VatDataType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType @@ -78,7 +79,7 @@ UNTAXED = 'untaxed' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -153,11 +154,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md index 02ff8748..0e5b8efa 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md @@ -32,20 +32,20 @@ PaymentDataAlfabank | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getLogin()](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#method_getLogin) | | Возвращает имя пользователя в Альфа-Клике | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setLogin()](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#method_setLogin) | | Устанавливает имя пользователя в Альфа-Клике | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataAlfabank.php](../../lib/Model/PaymentData/PaymentDataAlfabank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -60,7 +60,7 @@ PaymentDataAlfabank Имя пользователя в Альфа-Клике -**Type:** string +**Type:** string **Details:** @@ -72,7 +72,7 @@ PaymentDataAlfabank Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -240,109 +240,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -385,28 +365,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -424,6 +382,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -435,11 +415,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md index 96c8d146..83fd61de 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md @@ -34,20 +34,20 @@ PaymentDataApplePay | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getPaymentData()](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#method_getPaymentData) | | Возвращает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPaymentData()](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#method_setPaymentData) | | Устанавливает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataApplePay.php](../../lib/Model/PaymentData/PaymentDataApplePay.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -62,7 +62,7 @@ PaymentDataApplePay содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 -**Type:** string +**Type:** string **Details:** @@ -74,7 +74,7 @@ PaymentDataApplePay содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 -**Type:** string +**Type:** string **Details:** @@ -86,7 +86,7 @@ PaymentDataApplePay Тип объекта -**Type:** string +**Type:** string **Details:** @@ -98,7 +98,7 @@ PaymentDataApplePay Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -266,109 +266,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -411,28 +391,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -450,6 +408,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -461,11 +441,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md index d91b9d4f..4a8e30c4 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md @@ -34,21 +34,21 @@ PaymentDataB2BSberbank | public | [getPaymentPurpose()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_getPaymentPurpose) | | Возвращает назначение платежа | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | | public | [getVatData()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_getVatData) | | Возвращает назначение платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPaymentPurpose()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_setPaymentPurpose) | | Устанавливает назначение платежа | | public | [setVatData()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_setVatData) | | Устанавливает назначение платежа | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataB2bSberbank.php](../../lib/Model/PaymentData/PaymentDataB2bSberbank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -63,7 +63,7 @@ PaymentDataB2BSberbank Назначение платежа -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ PaymentDataB2BSberbank Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -88,7 +88,7 @@ PaymentDataB2BSberbank Данные об НДС -**Type:** VatData +**Type:** VatData **Details:** @@ -272,109 +272,89 @@ public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -439,28 +419,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -478,6 +436,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -489,11 +469,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md index cb0c4366..83c37a16 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md @@ -32,20 +32,20 @@ PaymentDataBankCard | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getCard()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#method_getCard) | | Возвращает данные банковской карты | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCard()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#method_setCard) | | Устанавливает данные банковской карты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataBankCard.php](../../lib/Model/PaymentData/PaymentDataBankCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -60,7 +60,7 @@ PaymentDataBankCard Данные банковской карты -**Type:** PaymentDataBankCardCard +**Type:** PaymentDataBankCardCard **Details:** @@ -72,7 +72,7 @@ PaymentDataBankCard Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -240,109 +240,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -385,28 +365,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -424,6 +382,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -435,11 +415,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md index e4018709..7b869ba3 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md @@ -40,11 +40,11 @@ | public | [getExpiryMonth()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getExpiryMonth) | | Возвращает месяц срока действия карты | | public | [getExpiryYear()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getExpiryYear) | | Возвращает год срока действия карты | | public | [getNumber()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getNumber) | | Возвращает номер банковской карты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCardholder()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setCardholder) | | Устанавливает имя держателя карты | | public | [setCsc()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setCsc) | | Устанавливает CVV2/CVC2 код | | public | [setExpiryMonth()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setExpiryMonth) | | Устанавливает месяц срока действия карты | @@ -56,7 +56,7 @@ --- ### Details * File: [lib/Model/PaymentData/PaymentDataBankCardCard.php](../../lib/Model/PaymentData/PaymentDataBankCardCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentData\PaymentDataBankCardCard @@ -70,7 +70,7 @@ Имя держателя карты -**Type:** string +**Type:** string **Details:** @@ -82,7 +82,7 @@ CVV2/CVC2 код -**Type:** string +**Type:** string **Details:** @@ -94,7 +94,7 @@ CVV2/CVC2 код Срок действия, месяц, MM -**Type:** string +**Type:** string **Details:** @@ -106,7 +106,7 @@ CVV2/CVC2 код Срок действия, год, YY -**Type:** string +**Type:** string **Details:** @@ -118,7 +118,7 @@ CVV2/CVC2 код Срок действия, месяц, MM -**Type:** string +**Type:** string **Details:** @@ -130,7 +130,7 @@ CVV2/CVC2 код Срок действия, год, YY -**Type:** string +**Type:** string **Details:** @@ -142,7 +142,7 @@ CVV2/CVC2 код Номер банковской карты -**Type:** string +**Type:** string **Details:** @@ -369,109 +369,89 @@ public getNumber() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -630,11 +610,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md index 51e07b59..98a7bd27 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md @@ -32,20 +32,20 @@ PaymentDataCash | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataCash.php](../../lib/Model/PaymentData/PaymentDataCash.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -60,7 +60,7 @@ PaymentDataCash Номер телефона в формате ITU-T E.164 -**Type:** string +**Type:** string **Details:** @@ -72,7 +72,7 @@ PaymentDataCash Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -240,109 +240,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -385,28 +365,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -424,6 +382,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -435,11 +415,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md index 674c8ac8..334b31b8 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md @@ -84,11 +84,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md index 7212b420..1a8910d6 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md @@ -34,21 +34,21 @@ PaymentDataGooglePay | public | [getGoogleTransactionId()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_getGoogleTransactionId) | | Возвращает уникальный идентификатор транзакции, выданный Google | | public | [getPaymentMethodToken()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_getPaymentMethodToken) | | Возвращает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setGoogleTransactionId()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_setGoogleTransactionId) | | Устанавливает уникальный идентификатор транзакции, выданный Google | | public | [setPaymentMethodToken()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_setPaymentMethodToken) | | Устанавливает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataGooglePay.php](../../lib/Model/PaymentData/PaymentDataGooglePay.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -63,7 +63,7 @@ PaymentDataGooglePay Уникальный идентификатор транзакции, выданный Google -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ PaymentDataGooglePay Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay -**Type:** string +**Type:** string **Details:** @@ -87,7 +87,7 @@ PaymentDataGooglePay Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -272,109 +272,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -439,28 +419,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -478,6 +436,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -489,11 +469,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md index b1d4da09..81fe32da 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataInstallments.php](../../lib/Model/PaymentData/PaymentDataInstallments.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -207,109 +207,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -330,28 +310,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -369,6 +327,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -380,11 +360,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md index 377136ac..f5bbb919 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md @@ -32,20 +32,20 @@ PaymentDataMobileBalance | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataMobileBalance.php](../../lib/Model/PaymentData/PaymentDataMobileBalance.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ PaymentDataMobileBalance #### public $phone : string --- -**Type:** string +**Type:** string **Details:** @@ -68,7 +68,7 @@ PaymentDataMobileBalance Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -236,109 +236,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -381,28 +361,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -420,6 +378,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -431,11 +411,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md index efa3260b..0226ca4e 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md @@ -31,20 +31,20 @@ PaymentDataQiwi | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataQiwi.php](../../lib/Model/PaymentData/PaymentDataQiwi.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -59,7 +59,7 @@ PaymentDataQiwi Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -227,109 +227,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -372,28 +352,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -411,6 +369,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -422,11 +402,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md index 7ad96da9..3f134201 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md @@ -32,20 +32,20 @@ PaymentDataSberbank | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataSberbank.php](../../lib/Model/PaymentData/PaymentDataSberbank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ PaymentDataSberbank #### public $phone : string --- -**Type:** string +**Type:** string **Details:** @@ -68,7 +68,7 @@ PaymentDataSberbank Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -236,109 +236,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -381,28 +361,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -420,6 +378,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -431,11 +411,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataSbp.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSbp.md index c6889124..276d3b0b 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataSbp.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSbp.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataSbp.php](../../lib/Model/PaymentData/PaymentDataSbp.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -207,109 +207,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -330,28 +310,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -369,6 +327,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -380,11 +360,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md index cd01cfb9..d6f94c9d 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataTinkoffBank.php](../../lib/Model/PaymentData/PaymentDataTinkoffBank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -207,109 +207,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -330,28 +310,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -369,6 +327,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -380,11 +360,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md index f074bc1f..44f0f7ae 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md @@ -30,19 +30,19 @@ PaymentDataWebmoney | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataWebmoney.php](../../lib/Model/PaymentData/PaymentDataWebmoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -57,7 +57,7 @@ PaymentDataWebmoney Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -208,109 +208,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -331,28 +311,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -370,6 +328,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -381,11 +361,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md index 86f17cfa..5df059cc 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -62,7 +62,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -213,109 +213,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -336,28 +316,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -375,6 +333,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -386,11 +366,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md index 01d82722..991245c0 100644 --- a/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/PaymentData/PaymentDataYooMoney.php](../../lib/Model/PaymentData/PaymentDataYooMoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -56,7 +56,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) @@ -207,109 +207,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -330,28 +310,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -369,6 +327,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -380,11 +360,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentInterface.md b/docs/classes/YooKassa-Model-PaymentInterface.md index ddaf49b5..7cb3e2bc 100644 --- a/docs/classes/YooKassa-Model-PaymentInterface.md +++ b/docs/classes/YooKassa-Model-PaymentInterface.md @@ -423,11 +423,11 @@ public getDeal() : \YooKassa\Model\Deal\PaymentDealInfo ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md b/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md index 82ed5cdb..111c8eb1 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md @@ -34,22 +34,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/AbstractPaymentMethod.php](../../lib/Model/PaymentMethod/AbstractPaymentMethod.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentMethod\AbstractPaymentMethod @@ -63,7 +63,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** @@ -87,7 +87,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** @@ -297,109 +297,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -486,28 +466,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -525,6 +483,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -536,11 +516,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md index 9ac5e63e..216d28b6 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md @@ -45,11 +45,11 @@ | public | [getInn()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getInn) | | Возвращает ИНН организации | | public | [getKpp()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getKpp) | | Возвращает КПП организации | | public | [getShortName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getShortName) | | Возвращает сокращенное наименование организации | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccount()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setAccount) | | Устанавливает номер счета организации | | public | [setAddress()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setAddress) | | Устанавливает адрес организации | | public | [setBankBik()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setBankBik) | | Устанавливает БИК банка организации | @@ -65,7 +65,7 @@ --- ### Details * File: [lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php](../../lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails @@ -81,7 +81,7 @@ Номер счета организации -**Type:** string +**Type:** string **Details:** @@ -93,7 +93,7 @@ Адрес организации -**Type:** string +**Type:** string **Details:** @@ -105,7 +105,7 @@ БИК банка организации -**Type:** string +**Type:** string **Details:** @@ -117,7 +117,7 @@ Отделение банка организации -**Type:** string +**Type:** string **Details:** @@ -129,7 +129,7 @@ Наименование банка организации -**Type:** string +**Type:** string **Details:** @@ -141,7 +141,7 @@ Полное наименование организации -**Type:** string +**Type:** string **Details:** @@ -153,7 +153,7 @@ ИНН организации -**Type:** string +**Type:** string **Details:** @@ -165,7 +165,7 @@ КПП организации -**Type:** string +**Type:** string **Details:** @@ -177,7 +177,7 @@ Сокращенное наименование организации -**Type:** string +**Type:** string **Details:** @@ -472,109 +472,89 @@ public getShortName() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -821,11 +801,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md index 683964e0..803c0103 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md @@ -211,11 +211,11 @@ public getAccount() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-BankCard.md b/docs/classes/YooKassa-Model-PaymentMethod-BankCard.md index baf57a95..d7662095 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-BankCard.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-BankCard.md @@ -50,11 +50,11 @@ | public | [getIssuerName()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_getIssuerName) | | Возвращает наименование банка, выпустившего карту | | public | [getLast4()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_getLast4) | | Возвращает последние 4 цифры номера карты | | public | [getSource()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_getSource) | | Возвращает источник данных банковской карты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCardType()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_setCardType) | | Устанавливает тип банковской карты | | public | [setExpiryMonth()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_setExpiryMonth) | | Устанавливает срок действия, месяц | | public | [setExpiryYear()](../classes/YooKassa-Model-PaymentMethod-BankCard.md#method_setExpiryYear) | | Устанавливает срок действия, год | @@ -69,7 +69,7 @@ --- ### Details * File: [lib/Model/PaymentMethod/BankCard.php](../../lib/Model/PaymentMethod/BankCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\PaymentMethod\BankCard @@ -79,7 +79,7 @@ ###### ISO_3166_CODE_LENGTH ```php -ISO_3166_CODE_LENGTH = 2 : string +ISO_3166_CODE_LENGTH = 2 : int ``` @@ -93,7 +93,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -105,7 +105,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -117,7 +117,7 @@ ISO_3166_CODE_LENGTH = 2 : string Срок действия, месяц -**Type:** string +**Type:** string **Details:** @@ -129,7 +129,7 @@ ISO_3166_CODE_LENGTH = 2 : string Срок действия, год -**Type:** string +**Type:** string **Details:** @@ -141,7 +141,7 @@ ISO_3166_CODE_LENGTH = 2 : string Срок действия, месяц -**Type:** string +**Type:** string **Details:** @@ -153,7 +153,7 @@ ISO_3166_CODE_LENGTH = 2 : string Срок действия, год -**Type:** string +**Type:** string **Details:** @@ -165,7 +165,7 @@ ISO_3166_CODE_LENGTH = 2 : string Первые 6 цифр номера карты -**Type:** string +**Type:** string **Details:** @@ -177,7 +177,7 @@ ISO_3166_CODE_LENGTH = 2 : string Код страны, в которой выпущена карта -**Type:** string +**Type:** string **Details:** @@ -189,7 +189,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -201,7 +201,7 @@ ISO_3166_CODE_LENGTH = 2 : string Код страны, в которой выпущена карта -**Type:** string +**Type:** string **Details:** @@ -213,7 +213,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -225,7 +225,7 @@ ISO_3166_CODE_LENGTH = 2 : string Последние 4 цифры номера карты -**Type:** string +**Type:** string **Details:** @@ -237,7 +237,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -519,109 +519,89 @@ public getSource() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -850,11 +830,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md b/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md index f0a00e6c..7b83282a 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md @@ -6,20 +6,21 @@ **Summary:** BankCardSource - Источник данных банковской карты -|Код|Описание| ---- | --- -|apple_pay|Источник данных apple_pay| -|google_pay|Источник данных google_pay| -|mir_pay|Источник данных mir_pay| +**Description:** + +Возможные значения: +- apple_pay - Источник данных ApplePay +- google_pay - Источник данных GooglePay +- mir_pay - Источник данных MirPay --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [APPLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_APPLE_PAY) | | | -| public | [GOOGLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_GOOGLE_PAY) | | | -| public | [MIR_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_MIR_PAY) | | | +| public | [APPLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_APPLE_PAY) | | Источник данных ApplePay | +| public | [GOOGLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_GOOGLE_PAY) | | Источник данных GooglePay | +| public | [MIR_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_MIR_PAY) | | Источник данных MirPay | --- ### Properties @@ -38,7 +39,7 @@ BankCardSource - Источник данных банковской карты --- ### Details * File: [lib/Model/PaymentMethod/BankCardSource.php](../../lib/Model/PaymentMethod/BankCardSource.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentMethod\BankCardSource @@ -47,6 +48,8 @@ BankCardSource - Источник данных банковской карты ## Constants ###### APPLE_PAY +Источник данных ApplePay + ```php APPLE_PAY = 'apple_pay' ``` @@ -54,6 +57,8 @@ APPLE_PAY = 'apple_pay' ###### GOOGLE_PAY +Источник данных GooglePay + ```php GOOGLE_PAY = 'google_pay' ``` @@ -61,6 +66,8 @@ GOOGLE_PAY = 'google_pay' ###### MIR_PAY +Источник данных MirPay + ```php MIR_PAY = 'mir_pay' ``` @@ -72,7 +79,7 @@ MIR_PAY = 'mir_pay' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -147,11 +154,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md index 6bf48e0e..9d0d6449 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md @@ -37,23 +37,23 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setLogin()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#method_setLogin) | | Устанавливает имя пользователя в Альфа-Клике | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodAlfaBank.php](../../lib/Model/PaymentMethod/PaymentMethodAlfaBank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -68,7 +68,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -81,7 +81,7 @@ Имя пользователя в Альфа-Клике -**Type:** string +**Type:** string **Details:** @@ -93,7 +93,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -106,7 +106,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -119,7 +119,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -337,109 +337,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -548,28 +528,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -587,6 +545,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -598,11 +578,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md index d9d58a38..c9b34d30 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodApplePay.php](../../lib/Model/PaymentMethod/PaymentMethodApplePay.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md index 84a469a7..e8041147 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md @@ -42,11 +42,11 @@ | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | | public | [getVatData()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_getVatData) | | Возвращает назначение платежа | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setPayerBankDetails()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setPayerBankDetails) | | Устанавливает Банковские реквизиты плательщика (юридического лица или ИП). | | public | [setPaymentPurpose()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setPaymentPurpose) | | Устанавливает назначение платежа | @@ -54,13 +54,13 @@ | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [setVatData()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setVatData) | | Устанавливает назначение платежа | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php](../../lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -75,7 +75,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -88,7 +88,7 @@ Банковские реквизиты плательщика -**Type:** PayerBankDetails +**Type:** PayerBankDetails **Details:** @@ -100,7 +100,7 @@ Банковские реквизиты плательщика -**Type:** PayerBankDetails +**Type:** PayerBankDetails **Details:** @@ -112,7 +112,7 @@ Назначение платежа -**Type:** string +**Type:** string **Details:** @@ -124,7 +124,7 @@ Назначение платежа -**Type:** string +**Type:** string **Details:** @@ -136,7 +136,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -149,7 +149,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -162,7 +162,7 @@ Данные об НДС -**Type:** VatData +**Type:** VatData **Details:** @@ -414,109 +414,89 @@ public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -633,7 +613,7 @@ public setTitle(string $value) : mixed #### public setVatData() : mixed ```php -public setVatData(\YooKassa\Model\PaymentData\B2b\Sberbank\VatData $vatData) : mixed +public setVatData(\YooKassa\Model\PaymentData\B2b\Sberbank\VatData|array $vatData) : mixed ``` **Summary** @@ -646,7 +626,7 @@ public setVatData(\YooKassa\Model\PaymentData\B2b\Sberbank\VatData $vatData) : m ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\PaymentData\B2b\Sberbank\VatData | vatData | Данные об НДС | +| \YooKassa\Model\PaymentData\B2b\Sberbank\VatData OR array | vatData | Данные об НДС | **Returns:** mixed - @@ -669,28 +649,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -708,6 +666,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -719,11 +699,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md index a79b7312..773e4d0a 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md @@ -48,22 +48,22 @@ | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | | public | [jsonSerialize()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_jsonSerialize) | | | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCard()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setCard) | | Устанавливает данные банковской карты | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodBankCard.php](../../lib/Model/PaymentMethod/PaymentMethodBankCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -74,7 +74,7 @@ ###### ~~ISO_3166_CODE_LENGTH~~ ```php -ISO_3166_CODE_LENGTH = 2 : string +ISO_3166_CODE_LENGTH = 2 : int ``` **deprecated** @@ -90,7 +90,7 @@ ISO_3166_CODE_LENGTH = 2 : string Данные банковской карты -**Type:** string +**Type:** string **Details:** @@ -102,7 +102,7 @@ ISO_3166_CODE_LENGTH = 2 : string Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -115,7 +115,7 @@ ISO_3166_CODE_LENGTH = 2 : string Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -128,7 +128,7 @@ ISO_3166_CODE_LENGTH = 2 : string Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -141,7 +141,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип объекта -**Type:** string +**Type:** string **Details:** @@ -526,98 +526,78 @@ public jsonSerialize() : mixed **Returns:** mixed - -##### Tags -| Tag | Version | Description | -| --- | ------- | ----------- | -| inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -726,28 +706,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -765,6 +723,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -776,11 +756,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md index ed0e957b..8e338c6e 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md @@ -5,17 +5,27 @@ --- **Summary:** -Тип банковской карты. Возможные значения: +PaymentMethodCardType - Тип банковской карты. + +**Description:** + +Возможные значения: - `MasterCard` (для карт Mastercard и Maestro), - `Visa` (для карт Visa и Visa Electron), - `Mir`, - `UnionPay`, - `JCB`, - `AmericanExpress`, -- `DinersClub` +- `DinersClub`, +- `DiscoverCard`, +- `InstaPayment`, +- `InstaPaymentTM`, +- `Laser`, +- `Dankort`, +- `Solo`, +- `Switch`, - `Unknown`. - --- ### Constants | Visibility | Name | Flag | Summary | @@ -27,6 +37,13 @@ | public | [JCB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_JCB) | | | | public | [AMERICAN_EXPRESS](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_AMERICAN_EXPRESS) | | | | public | [DINERS_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_DINERS_CLUB) | | | +| public | [DISCOVER_CARD_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_DISCOVER_CARD_CLUB) | | | +| public | [INSTA_PAYMENT_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_INSTA_PAYMENT_CLUB) | | | +| public | [INSTA_PAYMENT_TM_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_INSTA_PAYMENT_TM_CLUB) | | | +| public | [LASER_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_LASER_CLUB) | | | +| public | [DANKORT_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_DANKORT_CLUB) | | | +| public | [SOLO_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_SOLO_CLUB) | | | +| public | [SWITCH_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_SWITCH_CLUB) | | | | public | [UNKNOWN](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_UNKNOWN) | | | --- @@ -46,7 +63,7 @@ --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodCardType.php](../../lib/Model/PaymentMethod/PaymentMethodCardType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentMethod\PaymentMethodCardType @@ -102,6 +119,55 @@ DINERS_CLUB = 'DinersClub' ``` + +###### DISCOVER_CARD_CLUB +```php +DISCOVER_CARD_CLUB = 'DiscoverCard' +``` + + + +###### INSTA_PAYMENT_CLUB +```php +INSTA_PAYMENT_CLUB = 'InstaPayment' +``` + + + +###### INSTA_PAYMENT_TM_CLUB +```php +INSTA_PAYMENT_TM_CLUB = 'InstaPaymentTM' +``` + + + +###### LASER_CLUB +```php +LASER_CLUB = 'Laser' +``` + + + +###### DANKORT_CLUB +```php +DANKORT_CLUB = 'Dankort' +``` + + + +###### SOLO_CLUB +```php +SOLO_CLUB = 'Solo' +``` + + + +###### SWITCH_CLUB +```php +SWITCH_CLUB = 'Switch' +``` + + ###### UNKNOWN ```php @@ -115,7 +181,7 @@ UNKNOWN = 'Unknown' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -190,11 +256,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md index 312a06df..4718c48c 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodCash.php](../../lib/Model/PaymentMethod/PaymentMethodCash.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md index b59878ed..e391eb5d 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md @@ -98,11 +98,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md index fca93a2e..3073c654 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodGooglePay.php](../../lib/Model/PaymentMethod/PaymentMethodGooglePay.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md index fd86fa67..67b93010 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodInstallments.php](../../lib/Model/PaymentMethod/PaymentMethodInstallments.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md index 906ef406..2dd72291 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md @@ -37,23 +37,23 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodMobileBalance.php](../../lib/Model/PaymentMethod/PaymentMethodMobileBalance.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -68,7 +68,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -81,7 +81,7 @@ Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату -**Type:** string +**Type:** string **Details:** @@ -93,7 +93,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -106,7 +106,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -119,7 +119,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -337,109 +337,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -548,28 +528,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -587,6 +545,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -598,11 +578,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md index 2e6cbb84..59ead099 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md @@ -34,22 +34,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodPsb.php](../../lib/Model/PaymentMethod/PaymentMethodPsb.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -64,7 +64,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -77,7 +77,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -90,7 +90,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -292,109 +292,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -481,28 +461,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -520,6 +478,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -531,11 +511,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md index 25ab4a59..6ee3aa8a 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodQiwi.php](../../lib/Model/PaymentMethod/PaymentMethodQiwi.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md index 3a5931f1..023e6a2f 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md @@ -50,24 +50,24 @@ | public | [getSource()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getSource) | *deprecated* | Возвращает источник данных банковской карты | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCard()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setCard) | | Устанавливает данные банковской карты | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodSberbank.php](../../lib/Model/PaymentMethod/PaymentMethodSberbank.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -81,7 +81,7 @@ Inherited from [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) ```php -ISO_3166_CODE_LENGTH = 2 : string +ISO_3166_CODE_LENGTH = 2 : int ``` **deprecated** @@ -97,7 +97,7 @@ ISO_3166_CODE_LENGTH = 2 : string Данные банковской карты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) @@ -110,7 +110,7 @@ ISO_3166_CODE_LENGTH = 2 : string Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -123,7 +123,7 @@ ISO_3166_CODE_LENGTH = 2 : string Телефон пользователя -**Type:** string +**Type:** string **Details:** @@ -135,7 +135,7 @@ ISO_3166_CODE_LENGTH = 2 : string Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -148,7 +148,7 @@ ISO_3166_CODE_LENGTH = 2 : string Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -161,7 +161,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип объекта -**Type:** string +**Type:** string **Details:** @@ -173,7 +173,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип объекта -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) @@ -565,109 +565,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -798,28 +778,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -837,6 +795,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -848,11 +828,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSbp.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSbp.md index e6597d0b..0dd89c44 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSbp.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSbp.md @@ -34,22 +34,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodSbp.php](../../lib/Model/PaymentMethod/PaymentMethodSbp.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -64,7 +64,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -77,7 +77,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -90,7 +90,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -292,109 +292,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -481,28 +461,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -520,6 +478,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -531,11 +511,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md index 3edb561f..b1b4d25a 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md @@ -34,17 +34,17 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details @@ -64,7 +64,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -77,7 +77,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -90,7 +90,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -292,109 +292,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -481,28 +461,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -520,6 +478,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -531,11 +511,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md index b99f387d..78c86b2c 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md @@ -35,22 +35,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodWebmoney.php](../../lib/Model/PaymentMethod/PaymentMethodWebmoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -65,7 +65,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -78,7 +78,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -91,7 +91,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -104,7 +104,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -305,109 +305,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -494,28 +474,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -533,6 +491,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -544,11 +524,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md index 43044a84..fc8b373a 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md @@ -34,22 +34,22 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodWechat.php](../../lib/Model/PaymentMethod/PaymentMethodWechat.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -70,7 +70,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -83,7 +83,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -96,7 +96,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -298,109 +298,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -487,28 +467,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -526,6 +484,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -537,11 +517,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md index afa787fa..8c68dc2d 100644 --- a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md @@ -38,23 +38,23 @@ | public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | | public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | | public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountNumber()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#method_setAccountNumber) | | Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата | | public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | | public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | | public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setType) | | Устанавливает тип объекта | --- ### Details * File: [lib/Model/PaymentMethod/PaymentMethodYooMoney.php](../../lib/Model/PaymentMethod/PaymentMethodYooMoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -69,7 +69,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -81,7 +81,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -93,7 +93,7 @@ Идентификатор записи о сохраненных платежных данных -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -106,7 +106,7 @@ Возможность многократного использования -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -119,7 +119,7 @@ Название метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) @@ -132,7 +132,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -350,109 +350,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -561,28 +541,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип объекта - -**Details:** -* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип объекта | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -600,6 +558,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + --- @@ -611,11 +591,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethodType.md b/docs/classes/YooKassa-Model-PaymentMethodType.md index 69fff571..a2e01e53 100644 --- a/docs/classes/YooKassa-Model-PaymentMethodType.md +++ b/docs/classes/YooKassa-Model-PaymentMethodType.md @@ -6,25 +6,26 @@ **Summary:** PaymentMethodType - Тип источника средств для проведения платежа -|Код|Описание| ---- | --- -|yoo_money|Платеж из кошелька ЮMoney| -|bank_card|Платеж с произвольной банковской карты| -|sberbank|Платеж СбербанкОнлайн| -|cash|Платеж наличными| -|mobile_balance|Платеж с баланса мобильного телефона| -|apple_pay|Платеж ApplePay| -|google_pay|Платеж Google Pay| -|qiwi|Платеж из кошелька Qiwi| -|webmoney|Платеж из кошелька Webmoney| -|alfabank|Платеж через Альфа-Клик| -|b2b_sberbank|Сбербанк Бизнес Онлайн| -|tinkoff_bank|Интернет-банк Тинькофф| -|psb|ПромсвязьБанк| -|installments|Заплатить по частям| -|wechat|Платеж через WeChat| -|sbp|Платеж через через сервис быстрых платежей| +**Description:** + +Возможные значения: +- `yoo_money` - Платеж из кошелька ЮMoney +- `bank_card` - Платеж с произвольной банковской карты +- `sberbank` - Платеж СбербанкОнлайн +- `cash` - Платеж наличными +- `mobile_balance` - Платеж с баланса мобильного телефона +- `apple_pay` - Платеж ApplePay +- `google_pay` - Платеж Google Pay +- `qiwi` - Платеж из кошелька Qiwi +- `webmoney` - Платеж из кошелька Webmoney +- `alfabank` - Платеж через Альфа-Клик +- `b2b_sberbank` - Сбербанк Бизнес Онлайн +- `tinkoff_bank` - Интернет-банк Тинькофф +- `psb` - ПромсвязьБанк +- `installments` - Заплатить по частям +- `wechat` - Платеж через WeChat +- `sbp` - Платеж через через сервис быстрых платежей --- ### Constants @@ -64,7 +65,7 @@ PaymentMethodType - Тип источника средств для провед --- ### Details * File: [lib/Model/PaymentMethodType.php](../../lib/Model/PaymentMethodType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentMethodType @@ -223,7 +224,7 @@ SBP = 'sbp' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -298,11 +299,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentStatus.md b/docs/classes/YooKassa-Model-PaymentStatus.md index f544214e..85e942d6 100644 --- a/docs/classes/YooKassa-Model-PaymentStatus.md +++ b/docs/classes/YooKassa-Model-PaymentStatus.md @@ -6,13 +6,14 @@ **Summary:** PaymentStatus - Состояние платежа -|Код|Описание| ---- | --- -|pending|Ожидает оплаты покупателем| -|waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| -|succeeded|Успешно оплачен и подтвержден магазином| -|canceled|Неуспех оплаты или отменен магазином (cancel)| +**Description:** + +Возможные значения: +- `pending` - Ожидает оплаты покупателем +- `waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) +- `succeeded` - Успешно оплачен и подтвержден магазином +- `canceled` - Неуспех оплаты или отменен магазином (cancel) --- ### Constants @@ -40,7 +41,7 @@ PaymentStatus - Состояние платежа --- ### Details * File: [lib/Model/PaymentStatus.php](../../lib/Model/PaymentStatus.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PaymentStatus @@ -89,7 +90,7 @@ CANCELED = 'canceled' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -164,11 +165,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-AbstractPayoutDestination.md b/docs/classes/YooKassa-Model-Payout-AbstractPayoutDestination.md index f3e847dd..e4580c36 100644 --- a/docs/classes/YooKassa-Model-Payout-AbstractPayoutDestination.md +++ b/docs/classes/YooKassa-Model-Payout-AbstractPayoutDestination.md @@ -29,19 +29,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/Payout/AbstractPayoutDestination.php](../../lib/Model/Payout/AbstractPayoutDestination.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Payout\AbstractPayoutDestination @@ -55,7 +55,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** @@ -214,109 +214,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -337,28 +317,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -376,6 +334,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -387,11 +367,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-IncomeReceipt.md b/docs/classes/YooKassa-Model-Payout-IncomeReceipt.md new file mode 100644 index 00000000..e897f9b4 --- /dev/null +++ b/docs/classes/YooKassa-Model-Payout-IncomeReceipt.md @@ -0,0 +1,586 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Payout\IncomeReceipt +### Namespace: [\YooKassa\Model\Payout](../namespaces/yookassa-model-payout.md) +--- +**Summary:** + +Класс, представляющий модель IncomeReceipt. + +**Description:** + +Данные чека, зарегистрированного в ФНС. Присутствует, если вы делаете выплату [самозанятому](/developers/payouts/scenario-extensions/self-employed). + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_SERVICE_NAME](../classes/YooKassa-Model-Payout-IncomeReceipt.md#constant_MAX_LENGTH_SERVICE_NAME) | | | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_amount) | | Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке. | +| public | [$npd_receipt_id](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_npd_receipt_id) | | Идентификатор чека в сервисе. | +| public | [$npdReceiptId](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_npdReceiptId) | | Идентификатор чека в сервисе. | +| public | [$service_name](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_service_name) | | Описание услуги, оказанной получателем выплаты. Не более 50 символов. | +| public | [$serviceName](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_serviceName) | | Описание услуги, оказанной получателем выплаты. Не более 50 символов. | +| public | [$url](../classes/YooKassa-Model-Payout-IncomeReceipt.md#property_url) | | Ссылка на зарегистрированный чек. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_getAmount) | | Возвращает amount. | +| public | [getNpdReceiptId()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_getNpdReceiptId) | | Возвращает npd_receipt_id. | +| public | [getServiceName()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_getServiceName) | | Возвращает service_name. | +| public | [getUrl()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_getUrl) | | Возвращает Ссылка на зарегистрированный чек. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setAmount()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_setAmount) | | Устанавливает amount. | +| public | [setNpdReceiptId()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_setNpdReceiptId) | | Устанавливает npd_receipt_id. | +| public | [setServiceName()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_setServiceName) | | Устанавливает service_name. | +| public | [setUrl()](../classes/YooKassa-Model-Payout-IncomeReceipt.md#method_setUrl) | | Устанавливает ссылка на зарегистрированный чек. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/Payout/IncomeReceipt.php](../../lib/Model/Payout/IncomeReceipt.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Payout\IncomeReceipt + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### MAX_LENGTH_SERVICE_NAME +```php +MAX_LENGTH_SERVICE_NAME = 50 : int +``` + + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface|null +--- +***Description*** + +Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке. + +**Type:** AmountInterface|null + +**Details:** + + + +#### public $npd_receipt_id : string|null +--- +***Description*** + +Идентификатор чека в сервисе. + +**Type:** string|null + +**Details:** + + + +#### public $npdReceiptId : string|null +--- +***Description*** + +Идентификатор чека в сервисе. + +**Type:** string|null + +**Details:** + + + +#### public $service_name : string +--- +***Description*** + +Описание услуги, оказанной получателем выплаты. Не более 50 символов. + +**Type:** string + +**Details:** + + + +#### public $serviceName : string +--- +***Description*** + +Описание услуги, оказанной получателем выплаты. Не более 50 символов. + +**Type:** string + +**Details:** + + + +#### public $url : string|null +--- +***Description*** + +Ссылка на зарегистрированный чек. + +**Type:** string|null + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface|null + +```php +public getAmount() : \YooKassa\Model\AmountInterface|null +``` + +**Summary** + +Возвращает amount. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +**Returns:** \YooKassa\Model\AmountInterface|null - + + + +#### public getNpdReceiptId() : string|null + +```php +public getNpdReceiptId() : string|null +``` + +**Summary** + +Возвращает npd_receipt_id. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +**Returns:** string|null - + + + +#### public getServiceName() : string + +```php +public getServiceName() : string +``` + +**Summary** + +Возвращает service_name. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +**Returns:** string - + + + +#### public getUrl() : string|null + +```php +public getUrl() : string|null +``` + +**Summary** + +Возвращает Ссылка на зарегистрированный чек. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +**Returns:** string|null - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setAmount() : $this + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает amount. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR null | value | | + +**Returns:** $this - + + + +#### public setNpdReceiptId() : $this + +```php +public setNpdReceiptId(string|null $value = null) : $this +``` + +**Summary** + +Устанавливает npd_receipt_id. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор чека в сервисе. Пример: ~`208jd98zqe` | + +**Returns:** $this - + + + +#### public setServiceName() : $this + +```php +public setServiceName(string $value) : $this +``` + +**Summary** + +Устанавливает service_name. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Описание услуги, оказанной получателем выплаты. Не более 50 символов. | + +**Returns:** $this - + + + +#### public setUrl() : $this + +```php +public setUrl(string|null $value = null) : $this +``` + +**Summary** + +Устанавливает ссылка на зарегистрированный чек. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Ссылка на зарегистрированный чек Пример: ~`https://www.nalog.gov.ru/api/v1/receipt/<Идентификатор чека>/print` | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetails.md b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetails.md index 5868259a..f813b041 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetails.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetails.md @@ -31,11 +31,11 @@ PayoutCancellationDetails - Комментарий к отмене выплат | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getParty()](../classes/YooKassa-Model-Payout-PayoutCancellationDetails.md#method_getParty) | | Возвращает участника процесса выплаты, который принял решение об отмене транзакции | | public | [getReason()](../classes/YooKassa-Model-Payout-PayoutCancellationDetails.md#method_getReason) | | Возвращает причину отмены выплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setParty()](../classes/YooKassa-Model-Payout-PayoutCancellationDetails.md#method_setParty) | | Устанавливает участника процесса выплаты, который принял решение об отмене транзакции | | public | [setReason()](../classes/YooKassa-Model-Payout-PayoutCancellationDetails.md#method_setReason) | | Устанавливает причину отмены выплаты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -44,7 +44,7 @@ PayoutCancellationDetails - Комментарий к отмене выплат --- ### Details * File: [lib/Model/Payout/PayoutCancellationDetails.php](../../lib/Model/Payout/PayoutCancellationDetails.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Payout\PayoutCancellationDetails @@ -60,7 +60,7 @@ PayoutCancellationDetails - Комментарий к отмене выплат Инициатор отмены выплаты -**Type:** string +**Type:** string **Details:** @@ -72,7 +72,7 @@ PayoutCancellationDetails - Комментарий к отмене выплат Причина отмены выплаты -**Type:** string +**Type:** string **Details:** @@ -248,109 +248,89 @@ public getReason() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -443,11 +423,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md index 0fca39b9..4a954d48 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md @@ -12,7 +12,7 @@ PayoutCancellationDetailsPartyCode - Возможные инициаторы о ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [MERCHANT](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md#constant_MERCHANT) | | Платформа (вы) | +| public | [MERCHANT](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md#constant_MERCHANT) | *deprecated* | Платформа (вы) | | public | [YOO_KASSA](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md#constant_YOO_KASSA) | | ЮKassa | | public | [PAYMENT_NETWORK](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md#constant_PAYMENT_NETWORK) | | «Внешние» участники процесса выплаты (например, эмитент, сторонний платежный сервис) | @@ -33,7 +33,7 @@ PayoutCancellationDetailsPartyCode - Возможные инициаторы о --- ### Details * File: [lib/Model/Payout/PayoutCancellationDetailsPartyCode.php](../../lib/Model/Payout/PayoutCancellationDetailsPartyCode.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Payout\PayoutCancellationDetailsPartyCode @@ -41,13 +41,15 @@ PayoutCancellationDetailsPartyCode - Возможные инициаторы о --- ## Constants -###### MERCHANT +###### ~~MERCHANT~~ Платформа (вы) ```php MERCHANT = 'merchant' ``` +**deprecated** +Будет удален в будущих версиях ###### YOO_KASSA @@ -73,7 +75,7 @@ PAYMENT_NETWORK = 'payment_network' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -148,11 +150,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsReasonCode.md b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsReasonCode.md index 93aaad71..fd205f4d 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsReasonCode.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutCancellationDetailsReasonCode.md @@ -35,7 +35,7 @@ PayoutCancellationDetailsReasonCode - Возможные причины отме --- ### Details * File: [lib/Model/Payout/PayoutCancellationDetailsReasonCode.php](../../lib/Model/Payout/PayoutCancellationDetailsReasonCode.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Payout\PayoutCancellationDetailsReasonCode @@ -93,7 +93,7 @@ REJECTED_BY_PAYEE = 'rejected_by_payee' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -168,11 +168,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md index 9b04f421..723a9a97 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md @@ -32,20 +32,20 @@ PaymentDataBankCard | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getCard()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md#method_getCard) | | Возвращает данные банковской карты | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCard()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md#method_setCard) | | Устанавливает данные банковской карты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/Payout/PayoutDestinationBankCard.php](../../lib/Model/Payout/PayoutDestinationBankCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -60,7 +60,7 @@ PaymentDataBankCard Данные банковской карты -**Type:** PayoutDestinationBankCardCard +**Type:** PayoutDestinationBankCardCard **Details:** @@ -72,7 +72,7 @@ PaymentDataBankCard Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -240,109 +240,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -385,28 +365,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -424,6 +382,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -435,11 +415,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md index 1ed85c70..6d8b8538 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md @@ -43,11 +43,11 @@ | public | [getIssuerCountry()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_getIssuerCountry) | | Возвращает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 | | public | [getIssuerName()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_getIssuerName) | | Возвращает наименование банка, выпустившего карту | | public | [getLast4()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_getLast4) | | Возвращает последние 4 цифры номера карты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCardType()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_setCardType) | | Устанавливает тип банковской карты | | public | [setFirst6()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_setFirst6) | | Устанавливает первые 6 цифр номера карты | | public | [setIssuerCountry()](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md#method_setIssuerCountry) | | Устанавливает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 | @@ -59,7 +59,7 @@ --- ### Details * File: [lib/Model/Payout/PayoutDestinationBankCardCard.php](../../lib/Model/Payout/PayoutDestinationBankCardCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Payout\PayoutDestinationBankCardCard @@ -69,7 +69,7 @@ ###### ISO_3166_CODE_LENGTH ```php -ISO_3166_CODE_LENGTH = 2 : string +ISO_3166_CODE_LENGTH = 2 : int ``` @@ -83,7 +83,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -95,7 +95,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -107,7 +107,7 @@ ISO_3166_CODE_LENGTH = 2 : string Первые 6 цифр номера карты -**Type:** string +**Type:** string **Details:** @@ -119,7 +119,7 @@ ISO_3166_CODE_LENGTH = 2 : string Код страны, в которой выпущена карта -**Type:** string +**Type:** string **Details:** @@ -131,7 +131,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -143,7 +143,7 @@ ISO_3166_CODE_LENGTH = 2 : string Код страны, в которой выпущена карта -**Type:** string +**Type:** string **Details:** @@ -155,7 +155,7 @@ ISO_3166_CODE_LENGTH = 2 : string Тип банковской карты -**Type:** string +**Type:** string **Details:** @@ -167,7 +167,7 @@ ISO_3166_CODE_LENGTH = 2 : string Последние 4 цифры номера карты -**Type:** string +**Type:** string **Details:** @@ -398,109 +398,89 @@ public getLast4() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -663,11 +643,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationFactory.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationFactory.md index 89742b15..1ec70eb8 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutDestinationFactory.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationFactory.md @@ -84,11 +84,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationSbp.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationSbp.md new file mode 100644 index 00000000..8f8ce857 --- /dev/null +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationSbp.md @@ -0,0 +1,571 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Payout\PayoutDestinationSbp +### Namespace: [\YooKassa\Model\Payout](../namespaces/yookassa-model-payout.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через ЮMoney + + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$bank_id](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_bank_id) | | Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису | +| public | [$bankId](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_bankId) | | Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису | +| public | [$phone](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_phone) | | Телефон, к которому привязан счет получателя выплаты в системе участника СБП | +| public | [$recipient_checked](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_recipient_checked) | | Проверка получателя выплаты | +| public | [$recipientChecked](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_recipientChecked) | | Проверка получателя выплаты | +| public | [$type](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#property_type) | | Тип объекта | +| public | [$type](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#property_type) | | Тип метода оплаты | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getBankId()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_getBankId) | | Возвращает идентификатор выбранного участника СБП. | +| public | [getPhone()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_getPhone) | | Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. | +| public | [getRecipientChecked()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_getRecipientChecked) | | Возвращает признак тестовой операции | +| public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setBankId()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_setBankId) | | Устанавливает идентификатор выбранного участника СБП. | +| public | [setPhone()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_setPhone) | | Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. | +| public | [setRecipientChecked()](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md#method_setRecipientChecked) | | Устанавливает признак тестовой операции | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | + +--- +### Details +* File: [lib/Model/Payout/PayoutDestinationSbp.php](../../lib/Model/Payout/PayoutDestinationSbp.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + * \YooKassa\Model\Payout\PayoutDestinationSbp + +--- +## Properties + +#### public $bank_id : string +--- +***Description*** + +Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису + +**Type:** string + +**Details:** + + + +#### public $bankId : string +--- +***Description*** + +Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису + +**Type:** string + +**Details:** + + + +#### public $phone : string +--- +***Description*** + +Телефон, к которому привязан счет получателя выплаты в системе участника СБП + +**Type:** string + +**Details:** + + + +#### public $recipient_checked : string +--- +***Description*** + +Проверка получателя выплаты + +**Type:** string + +**Details:** + + + +#### public $recipientChecked : string +--- +***Description*** + +Проверка получателя выплаты + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getBankId() : string + +```php +public getBankId() : string +``` + +**Summary** + +Возвращает идентификатор выбранного участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +**Returns:** string - Идентификатор выбранного участника СБП + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +**Returns:** string - Телефон, к которому привязан счет получателя выплаты в системе участника СБП + + + +#### public getRecipientChecked() : bool + +```php +public getRecipientChecked() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setBankId() : $this + +```php +public setBankId(string $bankId) : $this +``` + +**Summary** + +Устанавливает идентификатор выбранного участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bankId | Идентификатор выбранного участника СБП | + +**Returns:** $this - + + + +#### public setPhone() : $this + +```php +public setPhone(string $phone) : $this +``` + +**Summary** + +Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | phone | Телефон, к которому привязан счет получателя выплаты в системе участника СБП | + +**Returns:** $this - + + + +#### public setRecipientChecked() : mixed + +```php +public setRecipientChecked(bool $value) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationType.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationType.md index f30ca1e2..51b23363 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutDestinationType.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationType.md @@ -6,11 +6,13 @@ **Summary:** PayoutDestinationType - Виды выплат -|Код|Описание| ---- | --- -|yoo_money|Выплата в кошелек ЮMoney| -|bank_card|Выплата на произвольную банковскую карту| +**Description:** + +Возможные значения: +- `yoo_money` - Выплата в кошелек ЮMoney +- `bank_card` - Выплата на произвольную банковскую карту +- `sbp` - Выплата через СБП на счет в банке или платежном сервисе --- ### Constants @@ -33,7 +35,7 @@ PayoutDestinationType - Виды выплат --- ### Details * File: [lib/Model/Payout/PayoutDestinationType.php](../../lib/Model/Payout/PayoutDestinationType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Payout\PayoutDestinationType @@ -43,7 +45,7 @@ PayoutDestinationType - Виды выплат #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -118,11 +120,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md b/docs/classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md index 2c3f4f16..12aa85e7 100644 --- a/docs/classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md +++ b/docs/classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md @@ -33,20 +33,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAccountNumber()](../classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md#method_getAccountNumber) | | Возвращает номер кошелька в ЮMoney, с которого была произведена оплата | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountNumber()](../classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md#method_setAccountNumber) | | Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Model/Payout/PayoutDestinationYooMoney.php](../../lib/Model/Payout/PayoutDestinationYooMoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -61,7 +61,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -73,7 +73,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -85,7 +85,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -97,7 +97,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -265,109 +265,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -410,28 +390,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -449,6 +407,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -460,11 +440,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-PayoutSelfEmployed.md b/docs/classes/YooKassa-Model-Payout-PayoutSelfEmployed.md new file mode 100644 index 00000000..f7557869 --- /dev/null +++ b/docs/classes/YooKassa-Model-Payout-PayoutSelfEmployed.md @@ -0,0 +1,383 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Payout\PayoutSelfEmployed +### Namespace: [\YooKassa\Model\Payout](../namespaces/yookassa-model-payout.md) +--- +**Summary:** + +Класс, представляющий модель PayoutSelfEmployed. + + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md#property_id) | | Идентификатор самозанятого в ЮKassa. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md#method_getId) | | Возвращает идентификатор самозанятого в ЮKassa. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setId()](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md#method_setId) | | Устанавливает идентификатор самозанятого в ЮKassa. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/Payout/PayoutSelfEmployed.php](../../lib/Model/Payout/PayoutSelfEmployed.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Payout\PayoutSelfEmployed + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор самозанятого в ЮKassa. + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор самозанятого в ЮKassa. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutSelfEmployed](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md) + +**Returns:** string - Идентификатор самозанятого в ЮKassa + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор самозанятого в ЮKassa. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\PayoutSelfEmployed](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор самозанятого в ЮKassa. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout-SbpParticipantBank.md b/docs/classes/YooKassa-Model-Payout-SbpParticipantBank.md new file mode 100644 index 00000000..9e7e5382 --- /dev/null +++ b/docs/classes/YooKassa-Model-Payout-SbpParticipantBank.md @@ -0,0 +1,447 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Payout\SbpParticipantBank +### Namespace: [\YooKassa\Model\Payout](../namespaces/yookassa-model-payout.md) +--- +**Summary:** + +Класс, представляющий модель SbpParticipantBank. + +**Description:** + +Участник СБП (Системы быстрых платежей ЦБ РФ) + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getBankId()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_getBankId) | | Возвращает bank_id. | +| public | [getBic()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_getBic) | | Возвращает bic. | +| public | [getName()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_getName) | | Возвращает name. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setBankId()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_setBankId) | | Устанавливает bank_id. | +| public | [setBic()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_setBic) | | Устанавливает bic. | +| public | [setName()](../classes/YooKassa-Model-Payout-SbpParticipantBank.md#method_setName) | | Устанавливает name. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/Payout/SbpParticipantBank.php](../../lib/Model/Payout/SbpParticipantBank.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Payout\SbpParticipantBank + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getBankId() : string + +```php +public getBankId() : string +``` + +**Summary** + +Возвращает bank_id. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +**Returns:** string - + + + +#### public getBic() : string + +```php +public getBic() : string +``` + +**Summary** + +Возвращает bic. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +**Returns:** string - + + + +#### public getName() : string + +```php +public getName() : string +``` + +**Summary** + +Возвращает name. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setBankId() : $this + +```php +public setBankId(string $bank_id) : $this +``` + +**Summary** + +Устанавливает bank_id. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bank_id | Идентификатор банка или платежного сервиса в СБП. | + +**Returns:** $this - + + + +#### public setBic() : $this + +```php +public setBic(string $bic) : $this +``` + +**Summary** + +Устанавливает bic. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bic | Банковский идентификационный код (БИК) банка или платежного сервиса. | + +**Returns:** $this - + + + +#### public setName() : $this + +```php +public setName(string $name) : $this +``` + +**Summary** + +Устанавливает name. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | Название банка или платежного сервиса в СБП. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payout.md b/docs/classes/YooKassa-Model-Payout.md index 426ed74f..4b7d8aac 100644 --- a/docs/classes/YooKassa-Model-Payout.md +++ b/docs/classes/YooKassa-Model-Payout.md @@ -29,6 +29,9 @@ Payout - Данные о выплате | public | [$metadata](../classes/YooKassa-Model-Payout.md#property_metadata) | | Метаданные выплаты указанные мерчантом | | public | [$payout_destination](../classes/YooKassa-Model-Payout.md#property_payout_destination) | | Способ проведения выплаты | | public | [$payoutDestination](../classes/YooKassa-Model-Payout.md#property_payoutDestination) | | Способ проведения выплаты | +| public | [$receipt](../classes/YooKassa-Model-Payout.md#property_receipt) | | Данные чека, зарегистрированного в ФНС | +| public | [$self_employed](../classes/YooKassa-Model-Payout.md#property_self_employed) | | Данные самозанятого, который получит выплату | +| public | [$selfEmployed](../classes/YooKassa-Model-Payout.md#property_selfEmployed) | | Данные самозанятого, который получит выплату | | public | [$status](../classes/YooKassa-Model-Payout.md#property_status) | | Текущее состояние выплаты | | public | [$test](../classes/YooKassa-Model-Payout.md#property_test) | | Признак тестовой операции | @@ -50,13 +53,15 @@ Payout - Данные о выплате | public | [getId()](../classes/YooKassa-Model-Payout.md#method_getId) | | Возвращает идентификатор выплаты | | public | [getMetadata()](../classes/YooKassa-Model-Payout.md#method_getMetadata) | | Возвращает метаданные выплаты установленные мерчантом | | public | [getPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_getPayoutDestination) | | Возвращает используемый способ проведения выплаты | +| public | [getReceipt()](../classes/YooKassa-Model-Payout.md#method_getReceipt) | | Возвращает данные чека, зарегистрированного в ФНС. | +| public | [getSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [getStatus()](../classes/YooKassa-Model-Payout.md#method_getStatus) | | Возвращает состояние выплаты | | public | [getTest()](../classes/YooKassa-Model-Payout.md#method_getTest) | | Возвращает признак тестовой операции | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payout.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payout.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | | public | [setCreatedAt()](../classes/YooKassa-Model-Payout.md#method_setCreatedAt) | | Устанавливает время создания заказа | @@ -65,6 +70,8 @@ Payout - Данные о выплате | public | [setId()](../classes/YooKassa-Model-Payout.md#method_setId) | | Устанавливает идентификатор выплаты | | public | [setMetadata()](../classes/YooKassa-Model-Payout.md#method_setMetadata) | | Устанавливает метаданные выплаты | | public | [setPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_setPayoutDestination) | | Устанавливает используемый способ проведения выплаты | +| public | [setReceipt()](../classes/YooKassa-Model-Payout.md#method_setReceipt) | | Устанавливает данные чека, зарегистрированного в ФНС. | +| public | [setSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | public | [setStatus()](../classes/YooKassa-Model-Payout.md#method_setStatus) | | Устанавливает статус выплаты | | public | [setTest()](../classes/YooKassa-Model-Payout.md#method_setTest) | | Устанавливает признак тестовой операции | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -73,7 +80,7 @@ Payout - Данные о выплате --- ### Details * File: [lib/Model/Payout.php](../../lib/Model/Payout.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Payout @@ -101,7 +108,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сумма выплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -113,7 +120,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** @@ -125,7 +132,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** @@ -161,7 +168,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сделка, в рамках которой нужно провести выплату -**Type:** PayoutDealInfo +**Type:** PayoutDealInfo **Details:** @@ -173,7 +180,7 @@ MAX_LENGTH_DESCRIPTION = 128 Описание транзакции -**Type:** string +**Type:** string **Details:** @@ -185,7 +192,7 @@ MAX_LENGTH_DESCRIPTION = 128 Идентификатор выплаты -**Type:** string +**Type:** string **Details:** @@ -197,7 +204,7 @@ MAX_LENGTH_DESCRIPTION = 128 Метаданные выплаты указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** @@ -209,7 +216,7 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** @@ -221,7 +228,43 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod + +**Details:** + + + +#### public $receipt : \YooKassa\Model\Payout\IncomeReceipt +--- +***Description*** + +Данные чека, зарегистрированного в ФНС + +**Type:** IncomeReceipt + +**Details:** + + + +#### public $self_employed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed + +**Details:** + + + +#### public $selfEmployed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed **Details:** @@ -233,7 +276,7 @@ MAX_LENGTH_DESCRIPTION = 128 Текущее состояние выплаты -**Type:** string +**Type:** string **Details:** @@ -245,7 +288,7 @@ MAX_LENGTH_DESCRIPTION = 128 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** @@ -526,6 +569,40 @@ public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMet **Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения выплаты + +#### public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null + +```php +public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null +``` + +**Summary** + +Возвращает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\IncomeReceipt|null - Данные чека, зарегистрированного в ФНС + + + +#### public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null + +```php +public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\PayoutSelfEmployed|null - Данные самозанятого, который получит выплату + + #### public getStatus() : string @@ -561,116 +638,96 @@ public getTest() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - #### public setAmount() : mixed ```php -public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : mixed ``` **Summary** @@ -683,7 +740,7 @@ public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма выплаты | **Returns:** mixed - @@ -743,7 +800,7 @@ public setCreatedAt(\DateTime|string|int $value) : mixed #### public setDeal() : mixed ```php -public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed +public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed ``` **Summary** @@ -756,7 +813,7 @@ public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Deal\PayoutDealInfo OR array | value | Сделка, в рамках которой нужно провести выплату | +| \YooKassa\Model\Deal\PayoutDealInfo OR array OR null | value | Сделка, в рамках которой нужно провести выплату | **Returns:** mixed - @@ -821,7 +878,7 @@ public setId(string $value) : mixed #### public setMetadata() : mixed ```php -public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed +public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ``` **Summary** @@ -834,7 +891,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Metadata OR array | value | Метаданные выплаты указанные мерчантом | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные выплаты указанные мерчантом | **Returns:** mixed - @@ -843,7 +900,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed #### public setPayoutDestination() : mixed ```php -public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array $value) : mixed +public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed ``` **Summary** @@ -856,11 +913,55 @@ public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|arr ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Payout\AbstractPayoutDestination OR array | value | Способ проведения выплаты | +| \YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null | value | Способ проведения выплаты | **Returns:** mixed - + +#### public setReceipt() : $this + +```php +public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\IncomeReceipt OR array OR null | value | Данные чека, зарегистрированного в ФНС | + +**Returns:** $this - + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\PayoutSelfEmployed OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + #### public setStatus() : mixed @@ -957,11 +1058,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PayoutInterface.md b/docs/classes/YooKassa-Model-PayoutInterface.md index 594a7469..5a26d961 100644 --- a/docs/classes/YooKassa-Model-PayoutInterface.md +++ b/docs/classes/YooKassa-Model-PayoutInterface.md @@ -233,11 +233,11 @@ public getTest() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PayoutStatus.md b/docs/classes/YooKassa-Model-PayoutStatus.md index 06d7bee3..fa26cfc9 100644 --- a/docs/classes/YooKassa-Model-PayoutStatus.md +++ b/docs/classes/YooKassa-Model-PayoutStatus.md @@ -6,12 +6,13 @@ **Summary:** PayoutStatus - Статус выплаты -|Код|Описание| ---- | --- -|pending|Выплата создана и ожидает подтверждения от эмитента| -|succeeded|Выплата успешно завершена| -|canceled|Выплата отменена| +**Description:** + +Возможные значения: +- `pending` - Выплата создана и ожидает подтверждения от эмитента +- `succeeded` - Выплата успешно завершена +- `canceled` - Выплата отменена --- ### Constants @@ -38,7 +39,7 @@ PayoutStatus - Статус выплаты --- ### Details * File: [lib/Model/PayoutStatus.php](../../lib/Model/PayoutStatus.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\PayoutStatus @@ -78,7 +79,7 @@ CANCELED = 'canceled' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -153,11 +154,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalData.md b/docs/classes/YooKassa-Model-PersonalData-PersonalData.md new file mode 100644 index 00000000..b6ce90e9 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalData.md @@ -0,0 +1,761 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalData +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalData. + +**Description:** + +Информация о персональных данных + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$cancellation_details](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_cancellation_details) | | Комментарий к отмене выплаты | +| public | [$cancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_cancellationDetails) | | Комментарий к отмене выплаты | +| public | [$created_at](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_created_at) | | Время создания персональных данных | +| public | [$createdAt](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_createdAt) | | Время создания персональных данных | +| public | [$expires_at](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_expires_at) | | Срок жизни объекта персональных данных | +| public | [$expiresAt](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_expiresAt) | | Срок жизни объекта персональных данных | +| public | [$id](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_id) | | Идентификатор персональных данных | +| public | [$metadata](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_metadata) | | Метаданные выплаты указанные мерчантом | +| public | [$status](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_status) | | Текущий статус персональных данных | +| public | [$type](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_type) | | Тип персональных данных | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getCancellationDetails) | | Возвращает cancellation_details. | +| public | [getCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getCreatedAt) | | Возвращает created_at. | +| public | [getExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getExpiresAt) | | Возвращает срок жизни объекта персональных данных. | +| public | [getId()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getId) | | Возвращает id. | +| public | [getMetadata()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getMetadata) | | Возвращает любые дополнительные данные. | +| public | [getStatus()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getStatus) | | Возвращает статус персональных данных. | +| public | [getType()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getType) | | Возвращает тип персональных данных. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setCancellationDetails) | | Устанавливает cancellation_details. | +| public | [setCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setCreatedAt) | | Устанавливает время создания персональных данных. | +| public | [setExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setExpiresAt) | | Устанавливает срок жизни объекта персональных данных. | +| public | [setId()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setId) | | Устанавливает id. | +| public | [setMetadata()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setMetadata) | | Устанавливает любые дополнительные данные. | +| public | [setStatus()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setStatus) | | Устанавливает статус персональных данных. | +| public | [setType()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setType) | | Устанавливает тип персональных данных. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalData.php](../../lib/Model/PersonalData/PersonalData.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PersonalData\PersonalData +* Implements: + * [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $cancellation_details : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails +--- +***Description*** + +Комментарий к отмене выплаты + +**Type:** PersonalDataCancellationDetails + +**Details:** + + + +#### public $cancellationDetails : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails +--- +***Description*** + +Комментарий к отмене выплаты + +**Type:** PersonalDataCancellationDetails + +**Details:** + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания персональных данных + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания персональных данных + +**Type:** \DateTime + +**Details:** + + + +#### public $expires_at : \DateTime|null +--- +***Description*** + +Срок жизни объекта персональных данных + +**Type:** DateTime|null + +**Details:** + + + +#### public $expiresAt : \DateTime|null +--- +***Description*** + +Срок жизни объекта персональных данных + +**Type:** DateTime|null + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор персональных данных + +**Type:** string + +**Details:** + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные выплаты указанные мерчантом + +**Type:** Metadata + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Текущий статус персональных данных + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип персональных данных + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null + +```php +public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null +``` + +**Summary** + +Возвращает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null - + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает created_at. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \DateTime - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает срок жизни объекта персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \DateTime|null - Срок жизни объекта персональных данных + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - + + + +#### public getMetadata() : array|null + +```php +public getMetadata() : array|null +``` + +**Summary** + +Возвращает любые дополнительные данные. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** array|null - Любые дополнительные данные + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - Статус персональных данных + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - Тип персональных данных + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : $this + +```php +public setCancellationDetails(\YooKassa\Model\PersonalData\PersonalDataCancellationDetails|array|null $cancellation_details) : $this +``` + +**Summary** + +Устанавливает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PersonalData\PersonalDataCancellationDetails OR array OR null | cancellation_details | | + +**Returns:** $this - + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания персональных данных | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** $this - + + + +#### public setExpiresAt() : $this + +```php +public setExpiresAt(\DateTime|string|int|null $expires_at = null) : $this +``` + +**Summary** + +Устанавливает срок жизни объекта персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | expires_at | Срок жизни объекта персональных данных | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** $this - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор персональных данных, сохраненных в ЮKassa. | + +**Returns:** $this - + + + +#### public setMetadata() : $this + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this +``` + +**Summary** + +Устанавливает любые дополнительные данные. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | metadata | Любые дополнительные данные | + +**Returns:** $this - + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус персональных данных | + +**Returns:** $this - + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип персональных данных | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md new file mode 100644 index 00000000..f96814b9 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md @@ -0,0 +1,406 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalDataCancellationDetails +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalDataCancellationDetails. + +**Description:** + +Комментарий к статусу ~`canceled`: кто и по какой причине аннулировал хранение данных. + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getParty()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_getParty) | | Возвращает party. | +| public | [getReason()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_getReason) | | Возвращает reason. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setParty()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_setParty) | | Устанавливает участника процесса, который принял решение о прекращении хранения персональных данных. | +| public | [setReason()](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md#method_setReason) | | Устанавливает причину прекращения хранения персональных данных. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataCancellationDetails.php](../../lib/Model/PersonalData/PersonalDataCancellationDetails.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PersonalData\PersonalDataCancellationDetails + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getParty() : string + +```php +public getParty() : string +``` + +**Summary** + +Возвращает party. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md) + +**Returns:** string - + + + +#### public getReason() : string + +```php +public getReason() : string +``` + +**Summary** + +Возвращает reason. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setParty() : self + +```php +public setParty(string $value) : self +``` + +**Summary** + +Устанавливает участника процесса, который принял решение о прекращении хранения персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Участник процесса, который принял решение о прекращении хранения персональных данных | + +**Returns:** self - + + + +#### public setReason() : self + +```php +public setReason(string $value) : self +``` + +**Summary** + +Устанавливает причину прекращения хранения персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Причина прекращения хранения персональных данных | + +**Returns:** self - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md new file mode 100644 index 00000000..54919730 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md @@ -0,0 +1,138 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalDataCancellationDetailsPartyCode +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +PayoutCancellationDetailsPartyCode - Возможные участники процесса, которые приняли решение о прекращении хранения персональных данных. + + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [YOO_KASSA](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md#constant_YOO_KASSA) | | ЮKassa | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataCancellationDetailsPartyCode.php](../../lib/Model/PersonalData/PersonalDataCancellationDetailsPartyCode.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PersonalData\PersonalDataCancellationDetailsPartyCode + +--- +## Constants + +###### YOO_KASSA +ЮKassa + +```php +YOO_KASSA = 'yoo_kassa' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md new file mode 100644 index 00000000..5f09a842 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md @@ -0,0 +1,138 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalDataCancellationDetailsReasonCode +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +PayoutCancellationDetailsReasonCode - Возможные причины аннулирования хранения данных. + + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [EXPIRED_BY_TIMEOUT](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md#constant_EXPIRED_BY_TIMEOUT) | | Истек срок хранения или использования персональных данных. | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataCancellationDetailsReasonCode.php](../../lib/Model/PersonalData/PersonalDataCancellationDetailsReasonCode.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PersonalData\PersonalDataCancellationDetailsReasonCode + +--- +## Constants + +###### EXPIRED_BY_TIMEOUT +Истек срок хранения или использования персональных данных. + +```php +EXPIRED_BY_TIMEOUT = 'expired_by_timeout' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataInterface.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataInterface.md new file mode 100644 index 00000000..7410d726 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataInterface.md @@ -0,0 +1,362 @@ +# [YooKassa API SDK](../home.md) + +# Interface: PersonalDataInterface +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalDataInterface. + +**Description:** + +Информация о персональных данных + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +* [public MIN_LENGTH_ID](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#constant_MIN_LENGTH_ID) +* [public MAX_LENGTH_ID](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#constant_MAX_LENGTH_ID) + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getCancellationDetails) | | Возвращает cancellation_details. | +| public | [getCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getCreatedAt) | | Возвращает created_at. | +| public | [getExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getExpiresAt) | | Возвращает expires_at. | +| public | [getId()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getId) | | Возвращает id. | +| public | [getMetadata()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getMetadata) | | Возвращает metadata. | +| public | [getStatus()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getStatus) | | Возвращает статус персональных данных. | +| public | [getType()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_getType) | | Возвращает тип персональных данных. | +| public | [setCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setCancellationDetails) | | Устанавливает cancellation_details. | +| public | [setCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setCreatedAt) | | Устанавливает время создания персональных данных. | +| public | [setExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setExpiresAt) | | Устанавливает срок жизни объекта персональных данных. | +| public | [setId()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setId) | | Устанавливает id. | +| public | [setMetadata()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setMetadata) | | Устанавливает metadata. | +| public | [setStatus()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setStatus) | | Устанавливает статус персональных данных. | +| public | [setType()](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md#method_setType) | | Устанавливает тип персональных данных. | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataInterface.php](../../lib/Model/PersonalData/PersonalDataInterface.php) +* Package: \YooKassa\Model + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### MIN_LENGTH_ID +```php +MIN_LENGTH_ID = 36 : int +``` + + + +###### MAX_LENGTH_ID +```php +MAX_LENGTH_ID = 50 : int +``` + + + +--- +## Methods + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** string - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор персональных данных, сохраненных в ЮKassa. | + +**Returns:** $this - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** string - Тип персональных данных + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип персональных данных | + +**Returns:** $this - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** string - Статус персональных данных + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус персональных данных | + +**Returns:** $this - + + + +#### public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null + +```php +public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null +``` + +**Summary** + +Возвращает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null - + + + +#### public setCancellationDetails() : $this + +```php +public setCancellationDetails(\YooKassa\Model\PersonalData\PersonalDataCancellationDetails|array|null $cancellation_details) : $this +``` + +**Summary** + +Устанавливает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PersonalData\PersonalDataCancellationDetails OR array OR null | cancellation_details | | + +**Returns:** $this - + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает created_at. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** \DateTime - + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания персональных данных | + +**Returns:** $this - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает expires_at. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** \DateTime|null - + + + +#### public setExpiresAt() : $this + +```php +public setExpiresAt(\DateTime|string|int|null $expires_at = null) : $this +``` + +**Summary** + +Устанавливает срок жизни объекта персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | expires_at | Срок жизни объекта персональных данных | + +**Returns:** $this - + + + +#### public getMetadata() : array|null + +```php +public getMetadata() : array|null +``` + +**Summary** + +Возвращает metadata. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +**Returns:** array|null - + + + +#### public setMetadata() : $this + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this +``` + +**Summary** + +Устанавливает metadata. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). | + +**Returns:** $this - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataStatus.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataStatus.md new file mode 100644 index 00000000..bbd142d8 --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataStatus.md @@ -0,0 +1,174 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalDataStatus +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalDataStatus. + +**Description:** + +Статус персональных данных. + +Возможные значения: +- `waiting_for_operation` — данные сохранены, но не использованы при проведении выплаты; +- `active` — данные сохранены и использованы при проведении выплаты; данные можно использовать повторно до срока, указанного в параметре `expires_at`; +- `canceled` — хранение данных отменено, данные удалены, инициатор и причина отмены указаны в объекте `cancellation_details` (финальный и неизменяемый статус). + +[Подробнее о жизненном цикле персональных данных](/developers/payouts/scenario-extensions/recipient-check#lifecircle) + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [WAITING_FOR_OPERATION](../classes/YooKassa-Model-PersonalData-PersonalDataStatus.md#constant_WAITING_FOR_OPERATION) | | Данные сохранены, но не использованы при проведении выплаты | +| public | [ACTIVE](../classes/YooKassa-Model-PersonalData-PersonalDataStatus.md#constant_ACTIVE) | | Данные сохранены и использованы при проведении выплаты | +| public | [CANCELED](../classes/YooKassa-Model-PersonalData-PersonalDataStatus.md#constant_CANCELED) | | Хранение данных отменено | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PersonalData-PersonalDataStatus.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataStatus.php](../../lib/Model/PersonalData/PersonalDataStatus.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PersonalData\PersonalDataStatus + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### WAITING_FOR_OPERATION +Данные сохранены, но не использованы при проведении выплаты + +```php +WAITING_FOR_OPERATION = 'waiting_for_operation' +``` + + + +###### ACTIVE +Данные сохранены и использованы при проведении выплаты + +```php +ACTIVE = 'active' +``` + + + +###### CANCELED +Хранение данных отменено + +```php +CANCELED = 'canceled' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PersonalData-PersonalDataType.md b/docs/classes/YooKassa-Model-PersonalData-PersonalDataType.md new file mode 100644 index 00000000..cc2af7aa --- /dev/null +++ b/docs/classes/YooKassa-Model-PersonalData-PersonalDataType.md @@ -0,0 +1,150 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PersonalData\PersonalDataType +### Namespace: [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalDataType. + +**Description:** + +Тип персональных данных — цель, для которой вы будете использовать данные. + +Возможное значение: +- `sbp_payout_recipient` — выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check). + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [SBP_PAYOUT_RECIPIENT](../classes/YooKassa-Model-PersonalData-PersonalDataType.md#constant_SBP_PAYOUT_RECIPIENT) | | Выплаты с проверкой получателя | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PersonalData-PersonalDataType.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/PersonalData/PersonalDataType.php](../../lib/Model/PersonalData/PersonalDataType.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PersonalData\PersonalDataType + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### SBP_PAYOUT_RECIPIENT +Выплаты с проверкой получателя + +```php +SBP_PAYOUT_RECIPIENT = 'sbp_payout_recipient' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-AdditionalUserProps.md b/docs/classes/YooKassa-Model-Receipt-AdditionalUserProps.md index 95e36c9e..46358e1a 100644 --- a/docs/classes/YooKassa-Model-Receipt-AdditionalUserProps.md +++ b/docs/classes/YooKassa-Model-Receipt-AdditionalUserProps.md @@ -37,11 +37,11 @@ Class AdditionalUserProps | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getName()](../classes/YooKassa-Model-Receipt-AdditionalUserProps.md#method_getName) | | Возвращает наименование дополнительного реквизита пользователя | | public | [getValue()](../classes/YooKassa-Model-Receipt-AdditionalUserProps.md#method_getValue) | | Возвращает значение дополнительного реквизита пользователя | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setName()](../classes/YooKassa-Model-Receipt-AdditionalUserProps.md#method_setName) | | Устанавливает наименование дополнительного реквизита пользователя | | public | [setValue()](../classes/YooKassa-Model-Receipt-AdditionalUserProps.md#method_setValue) | | Устанавливает значение дополнительного реквизита пользователя | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -81,7 +81,7 @@ VALUE_MAX_LENGTH = 234 : int Наименование дополнительного реквизита пользователя (тег в 54 ФЗ — 1085). Не более 64 символов. -**Type:** string +**Type:** string **Details:** @@ -93,7 +93,7 @@ VALUE_MAX_LENGTH = 234 : int Значение дополнительного реквизита пользователя (тег в 54 ФЗ — 1086). Не более 234 символов. -**Type:** string +**Type:** string **Details:** @@ -269,109 +269,89 @@ public getValue() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -464,11 +444,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-AgentType.md b/docs/classes/YooKassa-Model-Receipt-AgentType.md index a172b5ca..90963efd 100644 --- a/docs/classes/YooKassa-Model-Receipt-AgentType.md +++ b/docs/classes/YooKassa-Model-Receipt-AgentType.md @@ -5,20 +5,34 @@ --- **Summary:** -Базовый класс генерируемых enum'ов +AgentType - Тип посредника +**Description:** + +Тип посредника передается в запросе на создание чека в массиве `items`, в параметре `agent_type`, +если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек. +Параметр `agent_type` нужно передавать, начиная с ФФД 1.1. Убедитесь, что ваша онлайн-касса обновлена до этой версии. + +Возможные значения: +- `banking_payment_agent` - Безналичный расчет +- `banking_payment_subagent` - Предоплата (аванс) +- `payment_agent` - Постоплата (кредит) +- `payment_subagent` - Встречное предоставление +- `attorney` - Встречное предоставление +- `commissioner` - Встречное предоставление +- `agent` - Встречное предоставление --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [BANKING_PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_AGENT) | | | -| public | [BANKING_PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_SUBAGENT) | | | -| public | [PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_AGENT) | | | -| public | [PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_SUBAGENT) | | | -| public | [ATTORNEY](../classes/YooKassa-Model-Receipt-AgentType.md#constant_ATTORNEY) | | | -| public | [COMMISSIONER](../classes/YooKassa-Model-Receipt-AgentType.md#constant_COMMISSIONER) | | | -| public | [AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_AGENT) | | | +| public | [BANKING_PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_AGENT) | | Банковский платежный агент | +| public | [BANKING_PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_SUBAGENT) | | Банковский платежный субагент | +| public | [PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_AGENT) | | Платежный агент | +| public | [PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_SUBAGENT) | | Платежный субагент | +| public | [ATTORNEY](../classes/YooKassa-Model-Receipt-AgentType.md#constant_ATTORNEY) | | Поверенный | +| public | [COMMISSIONER](../classes/YooKassa-Model-Receipt-AgentType.md#constant_COMMISSIONER) | | Комиссионер | +| public | [AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_AGENT) | | Агент | --- ### Properties @@ -37,7 +51,7 @@ --- ### Details * File: [lib/Model/Receipt/AgentType.php](../../lib/Model/Receipt/AgentType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Receipt\AgentType @@ -46,6 +60,8 @@ ## Constants ###### BANKING_PAYMENT_AGENT +Банковский платежный агент + ```php BANKING_PAYMENT_AGENT = 'banking_payment_agent' ``` @@ -53,6 +69,8 @@ BANKING_PAYMENT_AGENT = 'banking_payment_agent' ###### BANKING_PAYMENT_SUBAGENT +Банковский платежный субагент + ```php BANKING_PAYMENT_SUBAGENT = 'banking_payment_subagent' ``` @@ -60,6 +78,8 @@ BANKING_PAYMENT_SUBAGENT = 'banking_payment_subagent' ###### PAYMENT_AGENT +Платежный агент + ```php PAYMENT_AGENT = 'payment_agent' ``` @@ -67,6 +87,8 @@ PAYMENT_AGENT = 'payment_agent' ###### PAYMENT_SUBAGENT +Платежный субагент + ```php PAYMENT_SUBAGENT = 'payment_subagent' ``` @@ -74,6 +96,8 @@ PAYMENT_SUBAGENT = 'payment_subagent' ###### ATTORNEY +Поверенный + ```php ATTORNEY = 'attorney' ``` @@ -81,6 +105,8 @@ ATTORNEY = 'attorney' ###### COMMISSIONER +Комиссионер + ```php COMMISSIONER = 'commissioner' ``` @@ -88,6 +114,8 @@ COMMISSIONER = 'commissioner' ###### AGENT +Агент + ```php AGENT = 'agent' ``` @@ -99,7 +127,7 @@ AGENT = 'agent' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -174,11 +202,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-IndustryDetails.md b/docs/classes/YooKassa-Model-Receipt-IndustryDetails.md index 15d58997..02a081be 100644 --- a/docs/classes/YooKassa-Model-Receipt-IndustryDetails.md +++ b/docs/classes/YooKassa-Model-Receipt-IndustryDetails.md @@ -45,11 +45,11 @@ Class IndustryDetails | public | [getDocumentNumber()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_getDocumentNumber) | | Возвращает номер нормативного акта федерального органа исполнительной власти | | public | [getFederalId()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_getFederalId) | | Возвращает идентификатор федерального органа исполнительной власти | | public | [getValue()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_getValue) | | Возвращает значение отраслевого реквизита | -| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setDocumentDate()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_setDocumentDate) | | Устанавливает дату документа основания | | public | [setDocumentNumber()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_setDocumentNumber) | | Устанавливает номер нормативного акта федерального органа исполнительной власти | | public | [setFederalId()](../classes/YooKassa-Model-Receipt-IndustryDetails.md#method_setFederalId) | | Устанавливает идентификатор федерального органа исполнительной власти | @@ -110,7 +110,7 @@ DOCUMENT_DATE_FORMAT = 'Y-m-d' : string Номер нормативного акта федерального органа исполнительной власти (тег в 54 ФЗ — 1264) -**Type:** string +**Type:** string **Details:** @@ -134,7 +134,7 @@ DOCUMENT_DATE_FORMAT = 'Y-m-d' : string Номер нормативного акта федерального органа исполнительной власти (тег в 54 ФЗ — 1264) -**Type:** string +**Type:** string **Details:** @@ -146,7 +146,7 @@ DOCUMENT_DATE_FORMAT = 'Y-m-d' : string Идентификатор федерального органа исполнительной власти (тег в 54 ФЗ — 1262) -**Type:** string +**Type:** string **Details:** @@ -158,7 +158,7 @@ DOCUMENT_DATE_FORMAT = 'Y-m-d' : string Идентификатор федерального органа исполнительной власти (тег в 54 ФЗ — 1262) -**Type:** string +**Type:** string **Details:** @@ -170,7 +170,7 @@ DOCUMENT_DATE_FORMAT = 'Y-m-d' : string Значение отраслевого реквизита (тег в 54 ФЗ — 1265) -**Type:** string +**Type:** string **Details:** @@ -386,10 +386,6 @@ public getValue() : string public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\Receipt\IndustryDetails](../classes/YooKassa-Model-Receipt-IndustryDetails.md) @@ -401,92 +397,76 @@ public jsonSerialize() : array | inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -628,11 +608,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-MarkCodeInfo.md b/docs/classes/YooKassa-Model-Receipt-MarkCodeInfo.md index d75bc210..2b9e5b1d 100644 --- a/docs/classes/YooKassa-Model-Receipt-MarkCodeInfo.md +++ b/docs/classes/YooKassa-Model-Receipt-MarkCodeInfo.md @@ -66,11 +66,11 @@ Class MarkCodeInfo | public | [getMarkCodeRaw()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_getMarkCodeRaw) | | Возвращает исходный код товара | | public | [getShort()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_getShort) | | | | public | [getUnknown()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_getUnknown) | | | -| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setEan13()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_setEan13) | | | | public | [setEan8()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_setEan8) | | | | public | [setEgais20()](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md#method_setEgais20) | | | @@ -182,7 +182,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате EAN-13 (тег в 54 ФЗ — 1302) -**Type:** string +**Type:** string **Details:** @@ -194,7 +194,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате EAN-8 (тег в 54 ФЗ — 1301) -**Type:** string +**Type:** string **Details:** @@ -206,7 +206,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате ЕГАИС-2.0 (тег в 54 ФЗ — 1308) -**Type:** string +**Type:** string **Details:** @@ -218,7 +218,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате ЕГАИС-3.0 (тег в 54 ФЗ — 1309) -**Type:** string +**Type:** string **Details:** @@ -230,7 +230,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Контрольно-идентификационный знак мехового изделия (тег в 54 ФЗ — 1307) -**Type:** string +**Type:** string **Details:** @@ -242,7 +242,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате GS1.0 (тег в 54 ФЗ — 1304) -**Type:** string +**Type:** string **Details:** @@ -254,7 +254,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате GS1.M (тег в 54 ФЗ — 1305) -**Type:** string +**Type:** string **Details:** @@ -266,7 +266,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате ITF-14 (тег в 54 ФЗ — 1303) -**Type:** string +**Type:** string **Details:** @@ -278,7 +278,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в том виде, в котором он был прочитан сканером (тег в 54 ФЗ — 2000) -**Type:** string +**Type:** string **Details:** @@ -290,7 +290,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в том виде, в котором он был прочитан сканером (тег в 54 ФЗ — 2000) -**Type:** string +**Type:** string **Details:** @@ -302,7 +302,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Код товара в формате короткого кода маркировки (тег в 54 ФЗ — 1306) -**Type:** string +**Type:** string **Details:** @@ -314,7 +314,7 @@ MAX_EGAIS_30_LENGTH = 14 : int Нераспознанный код товара (тег в 54 ФЗ — 1300) -**Type:** string +**Type:** string **Details:** @@ -609,10 +609,6 @@ public getUnknown() : string public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\Receipt\MarkCodeInfo](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md) @@ -624,92 +620,76 @@ public jsonSerialize() : array | inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -960,11 +940,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-MarkQuantity.md b/docs/classes/YooKassa-Model-Receipt-MarkQuantity.md index e64506c6..a3fef6ed 100644 --- a/docs/classes/YooKassa-Model-Receipt-MarkQuantity.md +++ b/docs/classes/YooKassa-Model-Receipt-MarkQuantity.md @@ -36,11 +36,11 @@ Class MarkQuantity | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getDenominator()](../classes/YooKassa-Model-Receipt-MarkQuantity.md#method_getDenominator) | | Возвращает знаменатель | | public | [getNumerator()](../classes/YooKassa-Model-Receipt-MarkQuantity.md#method_getNumerator) | | Возвращает числитель | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setDenominator()](../classes/YooKassa-Model-Receipt-MarkQuantity.md#method_setDenominator) | | Устанавливает знаменатель | | public | [setNumerator()](../classes/YooKassa-Model-Receipt-MarkQuantity.md#method_setNumerator) | | Устанавливает числитель | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -73,7 +73,7 @@ MIN_VALUE = 1 : int Знаменатель — общее количество товаров в потребительской упаковке (тег в 54 ФЗ — 1294) -**Type:** string +**Type:** string **Details:** @@ -85,7 +85,7 @@ MIN_VALUE = 1 : int Числитель — количество продаваемых товаров из одной потребительской упаковки (тег в 54 ФЗ — 1293) -**Type:** string +**Type:** string **Details:** @@ -261,109 +261,89 @@ public getNumerator() : int -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -456,11 +436,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-OperationalDetails.md b/docs/classes/YooKassa-Model-Receipt-OperationalDetails.md index 2f9568dc..7f2cfa75 100644 --- a/docs/classes/YooKassa-Model-Receipt-OperationalDetails.md +++ b/docs/classes/YooKassa-Model-Receipt-OperationalDetails.md @@ -41,11 +41,11 @@ Class OperationalDetails | public | [getCreatedAt()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_getCreatedAt) | | Возвращает время создания операции | | public | [getOperationId()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_getOperationId) | | Возвращает идентификатор операции | | public | [getValue()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_getValue) | | Возвращает данные операции | -| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCreatedAt()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_setCreatedAt) | | Устанавливает время создания операции | | public | [setOperationId()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_setOperationId) | | Устанавливает идентификатор операции | | public | [setValue()](../classes/YooKassa-Model-Receipt-OperationalDetails.md#method_setValue) | | Устанавливает данные операции | @@ -110,7 +110,7 @@ VALUE_MAX_LENGTH = 64 : int Идентификатор операции (тег в 54 ФЗ — 1271) -**Type:** string +**Type:** string **Details:** @@ -122,7 +122,7 @@ VALUE_MAX_LENGTH = 64 : int Идентификатор операции (тег в 54 ФЗ — 1271) -**Type:** string +**Type:** string **Details:** @@ -134,7 +134,7 @@ VALUE_MAX_LENGTH = 64 : int Данные операции (тег в 54 ФЗ — 1272) -**Type:** string +**Type:** string **Details:** @@ -333,10 +333,6 @@ public getValue() : string public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\Receipt\OperationalDetails](../classes/YooKassa-Model-Receipt-OperationalDetails.md) @@ -348,92 +344,76 @@ public jsonSerialize() : array | inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -553,11 +533,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-PaymentMode.md b/docs/classes/YooKassa-Model-Receipt-PaymentMode.md index a440379f..5270ba25 100644 --- a/docs/classes/YooKassa-Model-Receipt-PaymentMode.md +++ b/docs/classes/YooKassa-Model-Receipt-PaymentMode.md @@ -12,13 +12,13 @@ ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [FULL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PREPAYMENT) | | | -| public | [PARTIAL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PREPAYMENT) | | | -| public | [ADVANCE](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_ADVANCE) | | | -| public | [FULL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PAYMENT) | | | -| public | [PARTIAL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PAYMENT) | | | -| public | [CREDIT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT) | | | -| public | [CREDIT_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT_PAYMENT) | | | +| public | [FULL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PREPAYMENT) | | Полная предоплата | +| public | [PARTIAL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PREPAYMENT) | | Частичная предоплата | +| public | [ADVANCE](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_ADVANCE) | | Аванс | +| public | [FULL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PAYMENT) | | Полный расчет | +| public | [PARTIAL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PAYMENT) | | Частичный расчет и кредит | +| public | [CREDIT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT) | | Кредит | +| public | [CREDIT_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT_PAYMENT) | | Выплата по кредиту | --- ### Properties @@ -37,7 +37,7 @@ --- ### Details * File: [lib/Model/Receipt/PaymentMode.php](../../lib/Model/Receipt/PaymentMode.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Receipt\PaymentMode @@ -46,50 +46,64 @@ ## Constants ###### FULL_PREPAYMENT +Полная предоплата + ```php -FULL_PREPAYMENT = 'full_prepayment' : string +FULL_PREPAYMENT = 'full_prepayment' ``` ###### PARTIAL_PREPAYMENT +Частичная предоплата + ```php -PARTIAL_PREPAYMENT = 'partial_prepayment' : string +PARTIAL_PREPAYMENT = 'partial_prepayment' ``` ###### ADVANCE +Аванс + ```php -ADVANCE = 'advance' : string +ADVANCE = 'advance' ``` ###### FULL_PAYMENT +Полный расчет + ```php -FULL_PAYMENT = 'full_payment' : string +FULL_PAYMENT = 'full_payment' ``` ###### PARTIAL_PAYMENT +Частичный расчет и кредит + ```php -PARTIAL_PAYMENT = 'partial_payment' : string +PARTIAL_PAYMENT = 'partial_payment' ``` ###### CREDIT +Кредит + ```php -CREDIT = 'credit' : string +CREDIT = 'credit' ``` ###### CREDIT_PAYMENT +Выплата по кредиту + ```php -CREDIT_PAYMENT = 'credit_payment' : string +CREDIT_PAYMENT = 'credit_payment' ``` @@ -99,7 +113,7 @@ CREDIT_PAYMENT = 'credit_payment' : string #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -174,11 +188,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md b/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md index edbc4415..6cc175f3 100644 --- a/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md +++ b/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md @@ -12,39 +12,39 @@ ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [COMMODITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMMODITY) | | | -| public | [EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_EXCISE) | | | -| public | [JOB](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_JOB) | | | -| public | [SERVICE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SERVICE) | | | -| public | [GAMBLING_BET](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_BET) | | | -| public | [GAMBLING_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_PRIZE) | | | -| public | [LOTTERY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY) | | | -| public | [LOTTERY_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY_PRIZE) | | | -| public | [INTELLECTUAL_ACTIVITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INTELLECTUAL_ACTIVITY) | | | -| public | [PAYMENT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PAYMENT) | | | -| public | [AGENT_COMMISSION](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_AGENT_COMMISSION) | | | -| public | [PROPERTY_RIGHT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PROPERTY_RIGHT) | | | -| public | [NON_OPERATING_GAIN](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_OPERATING_GAIN) | | | -| public | [INSURANCE_PREMIUM](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INSURANCE_PREMIUM) | | | -| public | [SALES_TAX](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SALES_TAX) | | | -| public | [RESORT_FEE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_RESORT_FEE) | | | -| public | [COMPOSITE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMPOSITE) | | | -| public | [ANOTHER](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_ANOTHER) | | | -| public | [FINE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_FINE) | | | -| public | [TAX](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_TAX) | | | -| public | [LIEN](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LIEN) | | | -| public | [COST](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COST) | | | -| public | [PENSION_INSURANCE_WITHOUT_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PENSION_INSURANCE_WITHOUT_PAYOUTS) | | | -| public | [PENSION_INSURANCE_WITH_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PENSION_INSURANCE_WITH_PAYOUTS) | | | -| public | [HEALTH_INSURANCE_WITHOUT_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE_WITHOUT_PAYOUTS) | | | -| public | [HEALTH_INSURANCE_WITH_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE_WITH_PAYOUTS) | | | -| public | [HEALTH_INSURANCE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE) | | | -| public | [CASINO](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_CASINO) | | | -| public | [AGENT_WITHDRAWALS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_AGENT_WITHDRAWALS) | | | -| public | [NON_MARKED_EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_MARKED_EXCISE) | | | -| public | [MARKED_EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_MARKED_EXCISE) | | | -| public | [MARKED](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_MARKED) | | | -| public | [NON_MARKED](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_MARKED) | | | +| public | [COMMODITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMMODITY) | | Товар | +| public | [EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_EXCISE) | | Подакцизный товар | +| public | [JOB](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_JOB) | | Работа | +| public | [SERVICE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SERVICE) | | Услуга | +| public | [GAMBLING_BET](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_BET) | | Ставка в азартной игре | +| public | [GAMBLING_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_PRIZE) | | Выигрыш азартной игры | +| public | [LOTTERY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY) | | Лотерейный билет | +| public | [LOTTERY_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY_PRIZE) | | Выигрыш в лотерею | +| public | [INTELLECTUAL_ACTIVITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INTELLECTUAL_ACTIVITY) | | Результаты интеллектуальной деятельности | +| public | [PAYMENT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PAYMENT) | | Платеж | +| public | [AGENT_COMMISSION](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_AGENT_COMMISSION) | | Агентское вознаграждение | +| public | [PROPERTY_RIGHT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PROPERTY_RIGHT) | | Имущественное право | +| public | [NON_OPERATING_GAIN](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_OPERATING_GAIN) | | Внереализационный доход | +| public | [INSURANCE_PREMIUM](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INSURANCE_PREMIUM) | | Страховой сбор | +| public | [SALES_TAX](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SALES_TAX) | | Торговый сбор | +| public | [RESORT_FEE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_RESORT_FEE) | | Курортный сбор | +| public | [COMPOSITE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMPOSITE) | | Несколько вариантов | +| public | [ANOTHER](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_ANOTHER) | | Другое | +| public | [FINE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_FINE) | | Выплата | +| public | [TAX](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_TAX) | | Страховые взносы | +| public | [LIEN](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LIEN) | | Залог | +| public | [COST](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COST) | | Расход | +| public | [PENSION_INSURANCE_WITHOUT_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PENSION_INSURANCE_WITHOUT_PAYOUTS) | | Взносы на обязательное пенсионное страхование ИП | +| public | [PENSION_INSURANCE_WITH_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PENSION_INSURANCE_WITH_PAYOUTS) | | Взносы на обязательное пенсионное страхование | +| public | [HEALTH_INSURANCE_WITHOUT_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE_WITHOUT_PAYOUTS) | | Взносы на обязательное медицинское страхование ИП | +| public | [HEALTH_INSURANCE_WITH_PAYOUTS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE_WITH_PAYOUTS) | | Взносы на обязательное медицинское страхование | +| public | [HEALTH_INSURANCE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_HEALTH_INSURANCE) | | Взносы на обязательное социальное страхование | +| public | [CASINO](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_CASINO) | | Платеж казино | +| public | [AGENT_WITHDRAWALS](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_AGENT_WITHDRAWALS) | | Выдача денежных средств | +| public | [NON_MARKED_EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_MARKED_EXCISE) | | Подакцизный товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки (в чеке — АТНМ). Пример: алкогольная продукция | +| public | [MARKED_EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_MARKED_EXCISE) | | Подакцизный товар, подлежащий маркировке средством идентификации, имеющим код маркировки (в чеке — АТМ). Пример: табак | +| public | [MARKED](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_MARKED) | | Товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара (в чеке — ТМ). Пример: обувь, духи, товары легкой промышленности | +| public | [NON_MARKED](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_MARKED) | | Товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки, за исключением подакцизного товара (в чеке — ТНМ). Пример: меховые изделия | --- ### Properties @@ -63,7 +63,7 @@ --- ### Details * File: [lib/Model/Receipt/PaymentSubject.php](../../lib/Model/Receipt/PaymentSubject.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Receipt\PaymentSubject @@ -72,232 +72,298 @@ ## Constants ###### COMMODITY +Товар + ```php -COMMODITY = 'commodity' : string +COMMODITY = 'commodity' ``` ###### EXCISE +Подакцизный товар + ```php -EXCISE = 'excise' : string +EXCISE = 'excise' ``` ###### JOB +Работа + ```php -JOB = 'job' : string +JOB = 'job' ``` ###### SERVICE +Услуга + ```php -SERVICE = 'service' : string +SERVICE = 'service' ``` ###### GAMBLING_BET +Ставка в азартной игре + ```php -GAMBLING_BET = 'gambling_bet' : string +GAMBLING_BET = 'gambling_bet' ``` ###### GAMBLING_PRIZE +Выигрыш азартной игры + ```php -GAMBLING_PRIZE = 'gambling_prize' : string +GAMBLING_PRIZE = 'gambling_prize' ``` ###### LOTTERY +Лотерейный билет + ```php -LOTTERY = 'lottery' : string +LOTTERY = 'lottery' ``` ###### LOTTERY_PRIZE +Выигрыш в лотерею + ```php -LOTTERY_PRIZE = 'lottery_prize' : string +LOTTERY_PRIZE = 'lottery_prize' ``` ###### INTELLECTUAL_ACTIVITY +Результаты интеллектуальной деятельности + ```php -INTELLECTUAL_ACTIVITY = 'intellectual_activity' : string +INTELLECTUAL_ACTIVITY = 'intellectual_activity' ``` ###### PAYMENT +Платеж + ```php -PAYMENT = 'payment' : string +PAYMENT = 'payment' ``` ###### AGENT_COMMISSION +Агентское вознаграждение + ```php -AGENT_COMMISSION = 'agent_commission' : string +AGENT_COMMISSION = 'agent_commission' ``` ###### PROPERTY_RIGHT +Имущественное право + ```php -PROPERTY_RIGHT = 'property_right' : string +PROPERTY_RIGHT = 'property_right' ``` ###### NON_OPERATING_GAIN +Внереализационный доход + ```php -NON_OPERATING_GAIN = 'non_operating_gain' : string +NON_OPERATING_GAIN = 'non_operating_gain' ``` ###### INSURANCE_PREMIUM +Страховой сбор + ```php -INSURANCE_PREMIUM = 'insurance_premium' : string +INSURANCE_PREMIUM = 'insurance_premium' ``` ###### SALES_TAX +Торговый сбор + ```php -SALES_TAX = 'sales_tax' : string +SALES_TAX = 'sales_tax' ``` ###### RESORT_FEE +Курортный сбор + ```php -RESORT_FEE = 'resort_fee' : string +RESORT_FEE = 'resort_fee' ``` ###### COMPOSITE +Несколько вариантов + ```php -COMPOSITE = 'composite' : string +COMPOSITE = 'composite' ``` ###### ANOTHER +Другое + ```php -ANOTHER = 'another' : string +ANOTHER = 'another' ``` ###### FINE +Выплата + ```php -FINE = 'fine' : string +FINE = 'fine' ``` ###### TAX +Страховые взносы + ```php -TAX = 'tax' : string +TAX = 'tax' ``` ###### LIEN +Залог + ```php -LIEN = 'lien' : string +LIEN = 'lien' ``` ###### COST +Расход + ```php -COST = 'cost' : string +COST = 'cost' ``` ###### PENSION_INSURANCE_WITHOUT_PAYOUTS +Взносы на обязательное пенсионное страхование ИП + ```php -PENSION_INSURANCE_WITHOUT_PAYOUTS = 'pension_insurance_without_payouts' : string +PENSION_INSURANCE_WITHOUT_PAYOUTS = 'pension_insurance_without_payouts' ``` ###### PENSION_INSURANCE_WITH_PAYOUTS +Взносы на обязательное пенсионное страхование + ```php -PENSION_INSURANCE_WITH_PAYOUTS = 'pension_insurance_with_payouts' : string +PENSION_INSURANCE_WITH_PAYOUTS = 'pension_insurance_with_payouts' ``` ###### HEALTH_INSURANCE_WITHOUT_PAYOUTS +Взносы на обязательное медицинское страхование ИП + ```php -HEALTH_INSURANCE_WITHOUT_PAYOUTS = 'health_insurance_without_payouts' : string +HEALTH_INSURANCE_WITHOUT_PAYOUTS = 'health_insurance_without_payouts' ``` ###### HEALTH_INSURANCE_WITH_PAYOUTS +Взносы на обязательное медицинское страхование + ```php -HEALTH_INSURANCE_WITH_PAYOUTS = 'health_insurance_with_payouts' : string +HEALTH_INSURANCE_WITH_PAYOUTS = 'health_insurance_with_payouts' ``` ###### HEALTH_INSURANCE +Взносы на обязательное социальное страхование + ```php -HEALTH_INSURANCE = 'health_insurance' : string +HEALTH_INSURANCE = 'health_insurance' ``` ###### CASINO +Платеж казино + ```php -CASINO = 'casino' : string +CASINO = 'casino' ``` ###### AGENT_WITHDRAWALS +Выдача денежных средств + ```php -AGENT_WITHDRAWALS = 'agent_withdrawals' : string +AGENT_WITHDRAWALS = 'agent_withdrawals' ``` ###### NON_MARKED_EXCISE +Подакцизный товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки (в чеке — АТНМ). Пример: алкогольная продукция + ```php -NON_MARKED_EXCISE = 'non_marked_excise' : string +NON_MARKED_EXCISE = 'non_marked_excise' ``` ###### MARKED_EXCISE +Подакцизный товар, подлежащий маркировке средством идентификации, имеющим код маркировки (в чеке — АТМ). Пример: табак + ```php -MARKED_EXCISE = 'marked_excise' : string +MARKED_EXCISE = 'marked_excise' ``` ###### MARKED +Товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара (в чеке — ТМ). Пример: обувь, духи, товары легкой промышленности + ```php -MARKED = 'marked' : string +MARKED = 'marked' ``` ###### NON_MARKED +Товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки, за исключением подакцизного товара (в чеке — ТНМ). Пример: меховые изделия + ```php -NON_MARKED = 'non_marked' : string +NON_MARKED = 'non_marked' ``` @@ -307,7 +373,7 @@ NON_MARKED = 'non_marked' : string #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -382,11 +448,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md b/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md index 4a0e488b..8df05082 100644 --- a/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md +++ b/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md @@ -33,12 +33,12 @@ Class ReceiptItemAmount | public | [getIntegerValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | | public | [getValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_getValue) | | Возвращает значение суммы | | public | [increase()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_increase) | | Увеличивает сумму на указанное значение | -| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_jsonSerialize) | | | | public | [multiply()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_multiply) | | Умножает текущую сумму на указанный коэффициент | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCurrency()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_setCurrency) | | Устанавливает код валюты | | public | [setValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_setValue) | | Устанавливает значение суммы | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -63,7 +63,7 @@ Class ReceiptItemAmount Код валюты -**Type:** string +**Type:** string **Details:** @@ -75,7 +75,7 @@ Class ReceiptItemAmount Сумма -**Type:** int +**Type:** int **Details:** @@ -87,7 +87,7 @@ Class ReceiptItemAmount #### public __construct() : mixed ```php -public __construct(array|\YooKassa\Model\Receipt\numeric|null $value = null, string|null $currency = null) : mixed +public __construct(array|numeric-string|int|float|null $value = null, string|null $currency = null) : mixed ``` **Summary** @@ -100,7 +100,7 @@ MonetaryAmount constructor. ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array OR \YooKassa\Model\Receipt\numeric OR null | value | Сумма | +| array OR numeric-string OR int OR float OR null | value | Сумма | | string OR null | currency | Код валюты | **Returns:** mixed - @@ -304,10 +304,6 @@ public increase(int $value) : mixed public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) @@ -344,92 +340,76 @@ public multiply(float $coefficient) : mixed -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -533,11 +513,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md b/docs/classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md index 4c6b36d1..c4a37ab0 100644 --- a/docs/classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md +++ b/docs/classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md @@ -15,30 +15,30 @@ ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [PIECE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_PIECE) | | | -| public | [GRAM](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GRAM) | | | -| public | [KILOGRAM](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOGRAM) | | | -| public | [TON](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_TON) | | | -| public | [CENTIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_CENTIMETER) | | | -| public | [DECIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_DECIMETER) | | | -| public | [METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_METER) | | | -| public | [SQUARE_CENTIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_CENTIMETER) | | | -| public | [SQUARE_DECIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_DECIMETER) | | | -| public | [SQUARE_METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_METER) | | | -| public | [MILLILITER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MILLILITER) | | | -| public | [LITER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_LITER) | | | -| public | [CUBIC_METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_CUBIC_METER) | | | -| public | [KILOWATT_HOUR](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOWATT_HOUR) | | | -| public | [GIGACALORIE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GIGACALORIE) | | | -| public | [DAY](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_DAY) | | | -| public | [HOUR](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_HOUR) | | | -| public | [MINUTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MINUTE) | | | -| public | [SECOND](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SECOND) | | | -| public | [KILOBYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOBYTE) | | | -| public | [MEGABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MEGABYTE) | | | -| public | [GIGABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GIGABYTE) | | | -| public | [TERABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_TERABYTE) | | | -| public | [ANOTHER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_ANOTHER) | | | +| public | [PIECE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_PIECE) | | Штука, единица товара | +| public | [GRAM](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GRAM) | | Грамм | +| public | [KILOGRAM](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOGRAM) | | Килограмм | +| public | [TON](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_TON) | | Тонна | +| public | [CENTIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_CENTIMETER) | | Сантиметр | +| public | [DECIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_DECIMETER) | | Дециметр | +| public | [METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_METER) | | Метр | +| public | [SQUARE_CENTIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_CENTIMETER) | | Квадратный сантиметр | +| public | [SQUARE_DECIMETER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_DECIMETER) | | Квадратный дециметр | +| public | [SQUARE_METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SQUARE_METER) | | Квадратный метр | +| public | [MILLILITER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MILLILITER) | | Миллилитр | +| public | [LITER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_LITER) | | Литр | +| public | [CUBIC_METER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_CUBIC_METER) | | Кубический метр | +| public | [KILOWATT_HOUR](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOWATT_HOUR) | | Килловат-час | +| public | [GIGACALORIE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GIGACALORIE) | | Гигакалория | +| public | [DAY](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_DAY) | | Сутки | +| public | [HOUR](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_HOUR) | | Час | +| public | [MINUTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MINUTE) | | Минута | +| public | [SECOND](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_SECOND) | | Секунда | +| public | [KILOBYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_KILOBYTE) | | Килобайт | +| public | [MEGABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_MEGABYTE) | | Мегабайт | +| public | [GIGABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_GIGABYTE) | | Гигабайт | +| public | [TERABYTE](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_TERABYTE) | | Терабайт | +| public | [ANOTHER](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md#constant_ANOTHER) | | Другое | --- ### Properties @@ -57,7 +57,7 @@ --- ### Details * File: [lib/Model/Receipt/ReceiptItemMeasure.php](../../lib/Model/Receipt/ReceiptItemMeasure.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Receipt\ReceiptItemMeasure @@ -66,169 +66,217 @@ ## Constants ###### PIECE +Штука, единица товара + ```php -PIECE = 'piece' : string +PIECE = 'piece' ``` ###### GRAM +Грамм + ```php -GRAM = 'gram' : string +GRAM = 'gram' ``` ###### KILOGRAM +Килограмм + ```php -KILOGRAM = 'kilogram' : string +KILOGRAM = 'kilogram' ``` ###### TON +Тонна + ```php -TON = 'ton' : string +TON = 'ton' ``` ###### CENTIMETER +Сантиметр + ```php -CENTIMETER = 'centimeter' : string +CENTIMETER = 'centimeter' ``` ###### DECIMETER +Дециметр + ```php -DECIMETER = 'decimeter' : string +DECIMETER = 'decimeter' ``` ###### METER +Метр + ```php -METER = 'meter' : string +METER = 'meter' ``` ###### SQUARE_CENTIMETER +Квадратный сантиметр + ```php -SQUARE_CENTIMETER = 'square_centimeter' : string +SQUARE_CENTIMETER = 'square_centimeter' ``` ###### SQUARE_DECIMETER +Квадратный дециметр + ```php -SQUARE_DECIMETER = 'square_decimeter' : string +SQUARE_DECIMETER = 'square_decimeter' ``` ###### SQUARE_METER +Квадратный метр + ```php -SQUARE_METER = 'square_meter' : string +SQUARE_METER = 'square_meter' ``` ###### MILLILITER +Миллилитр + ```php -MILLILITER = 'milliliter' : string +MILLILITER = 'milliliter' ``` ###### LITER +Литр + ```php -LITER = 'liter' : string +LITER = 'liter' ``` ###### CUBIC_METER +Кубический метр + ```php -CUBIC_METER = 'cubic_meter' : string +CUBIC_METER = 'cubic_meter' ``` ###### KILOWATT_HOUR +Килловат-час + ```php -KILOWATT_HOUR = 'kilowatt_hour' : string +KILOWATT_HOUR = 'kilowatt_hour' ``` ###### GIGACALORIE +Гигакалория + ```php -GIGACALORIE = 'gigacalorie' : string +GIGACALORIE = 'gigacalorie' ``` ###### DAY +Сутки + ```php -DAY = 'day' : string +DAY = 'day' ``` ###### HOUR +Час + ```php -HOUR = 'hour' : string +HOUR = 'hour' ``` ###### MINUTE +Минута + ```php -MINUTE = 'minute' : string +MINUTE = 'minute' ``` ###### SECOND +Секунда + ```php -SECOND = 'second' : string +SECOND = 'second' ``` ###### KILOBYTE +Килобайт + ```php -KILOBYTE = 'kilobyte' : string +KILOBYTE = 'kilobyte' ``` ###### MEGABYTE +Мегабайт + ```php -MEGABYTE = 'megabyte' : string +MEGABYTE = 'megabyte' ``` ###### GIGABYTE +Гигабайт + ```php -GIGABYTE = 'gigabyte' : string +GIGABYTE = 'gigabyte' ``` ###### TERABYTE +Терабайт + ```php -TERABYTE = 'terabyte' : string +TERABYTE = 'terabyte' ``` ###### ANOTHER +Другое + ```php -ANOTHER = 'another' : string +ANOTHER = 'another' ``` @@ -238,7 +286,7 @@ ANOTHER = 'another' : string #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -313,11 +361,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-SettlementType.md b/docs/classes/YooKassa-Model-Receipt-SettlementType.md index 3759dd49..278c1d7a 100644 --- a/docs/classes/YooKassa-Model-Receipt-SettlementType.md +++ b/docs/classes/YooKassa-Model-Receipt-SettlementType.md @@ -5,17 +5,26 @@ --- **Summary:** -Базовый класс генерируемых enum'ов +SettlementType - Тип расчета +**Description:** + +Тип расчета передается в запросе на создание чека в массиве `settlements`, в параметре `type`. + +Возможные значения: +- `cashless` - Безналичный расчет +- `prepayment` - Предоплата (аванс) +- `postpayment` - Постоплата (кредит) +- `consideration` - Встречное предоставление --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [CASHLESS](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CASHLESS) | | | -| public | [PREPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_PREPAYMENT) | | | -| public | [POSTPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_POSTPAYMENT) | | | -| public | [CONSIDERATION](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CONSIDERATION) | | | +| public | [CASHLESS](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CASHLESS) | | Безналичный расчет | +| public | [PREPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_PREPAYMENT) | | Предоплата (аванс) | +| public | [POSTPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_POSTPAYMENT) | | Постоплата (кредит) | +| public | [CONSIDERATION](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CONSIDERATION) | | Встречное предоставление | --- ### Properties @@ -34,7 +43,7 @@ --- ### Details * File: [lib/Model/Receipt/SettlementType.php](../../lib/Model/Receipt/SettlementType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\Receipt\SettlementType @@ -43,6 +52,8 @@ ## Constants ###### CASHLESS +Безналичный расчет + ```php CASHLESS = 'cashless' ``` @@ -50,6 +61,8 @@ CASHLESS = 'cashless' ###### PREPAYMENT +Предоплата (аванс) + ```php PREPAYMENT = 'prepayment' ``` @@ -57,6 +70,8 @@ PREPAYMENT = 'prepayment' ###### POSTPAYMENT +Постоплата (кредит) + ```php POSTPAYMENT = 'postpayment' ``` @@ -64,6 +79,8 @@ POSTPAYMENT = 'postpayment' ###### CONSIDERATION +Встречное предоставление + ```php CONSIDERATION = 'consideration' ``` @@ -75,7 +92,7 @@ CONSIDERATION = 'consideration' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -150,11 +167,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt.md b/docs/classes/YooKassa-Model-Receipt.md index 8d6d96c5..b27e3c00 100644 --- a/docs/classes/YooKassa-Model-Receipt.md +++ b/docs/classes/YooKassa-Model-Receipt.md @@ -52,13 +52,13 @@ | public | [getSettlements()](../classes/YooKassa-Model-Receipt.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | | public | [getShippingAmountValue()](../classes/YooKassa-Model-Receipt.md#method_getShippingAmountValue) | | Возвращает стоимость доставки исходя из состава чека | | public | [getTaxSystemCode()](../classes/YooKassa-Model-Receipt.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [normalize()](../classes/YooKassa-Model-Receipt.md#method_normalize) | | Подгоняет стоимость товаров в чеке к общей цене заказа | | public | [notEmpty()](../classes/YooKassa-Model-Receipt.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAdditionalUserProps()](../classes/YooKassa-Model-Receipt.md#method_setAdditionalUserProps) | | Устанавливает дополнительный реквизит пользователя | | public | [setCustomer()](../classes/YooKassa-Model-Receipt.md#method_setCustomer) | | Устанавливает информацию о плательщике | | public | [setEmail()](../classes/YooKassa-Model-Receipt.md#method_setEmail) | *deprecated* | Устанавливает адрес электронной почты на который будет выслан чек | @@ -74,7 +74,7 @@ --- ### Details * File: [lib/Model/Receipt.php](../../lib/Model/Receipt.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Receipt @@ -90,7 +90,7 @@ Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084) -**Type:** AdditionalUserProps +**Type:** AdditionalUserProps **Details:** @@ -102,7 +102,7 @@ Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084) -**Type:** AdditionalUserProps +**Type:** AdditionalUserProps **Details:** @@ -114,7 +114,7 @@ Информация о плательщике -**Type:** ReceiptCustomer +**Type:** ReceiptCustomer **Details:** @@ -126,7 +126,7 @@ Список товаров в заказе -**Type:** ReceiptItemInterface[] +**Type:** ReceiptItemInterface[] **Details:** @@ -138,7 +138,7 @@ Отраслевой реквизит чека (тег в 54 ФЗ — 1261) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -150,7 +150,7 @@ Операционный реквизит чека (тег в 54 ФЗ — 1270) -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** @@ -162,7 +162,7 @@ Отраслевой реквизит чека (тег в 54 ФЗ — 1261) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -174,7 +174,7 @@ Операционный реквизит чека (тег в 54 ФЗ — 1270) -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** @@ -186,7 +186,7 @@ Массив оплат, обеспечивающих выдачу товара -**Type:** SettlementInterface[] +**Type:** SettlementInterface[] **Details:** @@ -198,7 +198,7 @@ Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** @@ -210,7 +210,7 @@ Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** @@ -609,20 +609,16 @@ public getTaxSystemCode() : int -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -666,92 +662,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1040,11 +1020,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptCustomer.md b/docs/classes/YooKassa-Model-ReceiptCustomer.md index c64c09d1..8ea5571f 100644 --- a/docs/classes/YooKassa-Model-ReceiptCustomer.md +++ b/docs/classes/YooKassa-Model-ReceiptCustomer.md @@ -37,11 +37,11 @@ | public | [getInn()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getInn) | | Возвращает ИНН плательщика | | public | [getPhone()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getPhone) | | Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | | public | [isEmpty()](../classes/YooKassa-Model-ReceiptCustomer.md#method_isEmpty) | | Проверка на заполненность объекта | -| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptCustomer.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptCustomer.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setEmail()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setEmail) | | Устанавливает адрес электронной почты на который будет выслан чек | | public | [setFullName()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setFullName) | | Устанавливает Название организации или ФИО | | public | [setInn()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setInn) | | Устанавливает ИНН плательщика | @@ -52,7 +52,7 @@ --- ### Details * File: [lib/Model/ReceiptCustomer.php](../../lib/Model/ReceiptCustomer.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\ReceiptCustomer @@ -68,7 +68,7 @@ E-mail адрес плательщика на который будет выслан чек. -**Type:** string +**Type:** string **Details:** @@ -80,7 +80,7 @@ E-mail адрес плательщика на который будет высл Для юрлица — название организации, для ИП и физического лица — ФИО. -**Type:** string +**Type:** string **Details:** @@ -92,7 +92,7 @@ E-mail адрес плательщика на который будет высл Для юрлица — название организации, для ИП и физического лица — ФИО. -**Type:** string +**Type:** string **Details:** @@ -104,7 +104,7 @@ E-mail адрес плательщика на который будет высл ИНН плательщика (10 или 12 цифр). -**Type:** string +**Type:** string **Details:** @@ -116,7 +116,7 @@ E-mail адрес плательщика на который будет высл Номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек. -**Type:** string +**Type:** string **Details:** @@ -349,10 +349,6 @@ public isEmpty() : bool public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) @@ -360,92 +356,76 @@ public jsonSerialize() : array -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -603,11 +583,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md b/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md index da2e3900..d7de00c7 100644 --- a/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md +++ b/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md @@ -135,11 +135,11 @@ public jsonSerialize() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptInterface.md b/docs/classes/YooKassa-Model-ReceiptInterface.md index 910a13dc..82631976 100644 --- a/docs/classes/YooKassa-Model-ReceiptInterface.md +++ b/docs/classes/YooKassa-Model-ReceiptInterface.md @@ -176,11 +176,11 @@ public normalize(\YooKassa\Model\AmountInterface $orderAmount, bool $withShippin ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptItem.md b/docs/classes/YooKassa-Model-ReceiptItem.md index fd2078f8..acec5938 100644 --- a/docs/classes/YooKassa-Model-ReceiptItem.md +++ b/docs/classes/YooKassa-Model-ReceiptItem.md @@ -85,11 +85,11 @@ | public | [getVatCode()](../classes/YooKassa-Model-ReceiptItem.md#method_getVatCode) | | Возвращает ставку НДС | | public | [increasePrice()](../classes/YooKassa-Model-ReceiptItem.md#method_increasePrice) | | Увеличивает цену товара на указанную величину | | public | [isShipping()](../classes/YooKassa-Model-ReceiptItem.md#method_isShipping) | | Проверяет, является ли текущий элемент чека доставкой | -| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptItem.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptItem.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAdditionalPaymentSubjectProps()](../classes/YooKassa-Model-ReceiptItem.md#method_setAdditionalPaymentSubjectProps) | | Устанавливает дополнительный реквизит предмета расчета | | public | [setAgentType()](../classes/YooKassa-Model-ReceiptItem.md#method_setAgentType) | | Устанавливает тип посредника, реализующего товар или услугу | | public | [setCountryOfOriginCode()](../classes/YooKassa-Model-ReceiptItem.md#method_setCountryOfOriginCode) | | Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира | @@ -115,7 +115,7 @@ --- ### Details * File: [lib/Model/ReceiptItem.php](../../lib/Model/ReceiptItem.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\ReceiptItem @@ -148,7 +148,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191) -**Type:** string +**Type:** string **Details:** @@ -160,7 +160,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191) -**Type:** string +**Type:** string **Details:** @@ -172,7 +172,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Тип посредника, реализующего товар или услугу -**Type:** string +**Type:** string **Details:** @@ -184,7 +184,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Тип посредника, реализующего товар или услугу -**Type:** string +**Type:** string **Details:** @@ -196,7 +196,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Суммарная стоимость покупаемого товара в копейках/центах -**Type:** float +**Type:** float **Details:** @@ -208,7 +208,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код страны происхождения товара (тег в 54 ФЗ — 1230) -**Type:** string +**Type:** string **Details:** @@ -220,7 +220,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код страны происхождения товара (тег в 54 ФЗ — 1230) -**Type:** string +**Type:** string **Details:** @@ -232,7 +232,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 -**Type:** string +**Type:** string **Details:** @@ -244,7 +244,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 -**Type:** string +**Type:** string **Details:** @@ -256,7 +256,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Наименование товара (тег в 54 ФЗ — 1030) -**Type:** string +**Type:** string **Details:** @@ -268,7 +268,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229) -**Type:** float +**Type:** float **Details:** @@ -280,7 +280,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Флаг доставки -**Type:** bool +**Type:** bool **Details:** @@ -292,7 +292,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код товара (тег в 54 ФЗ — 1163) -**Type:** MarkCodeInfo +**Type:** MarkCodeInfo **Details:** @@ -304,7 +304,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Режим обработки кода маркировки (тег в 54 ФЗ — 2102) -**Type:** string +**Type:** string **Details:** @@ -316,7 +316,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Дробное количество маркированного товара (тег в 54 ФЗ — 1291) -**Type:** MarkQuantity +**Type:** MarkQuantity **Details:** @@ -328,7 +328,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код товара (тег в 54 ФЗ — 1163) -**Type:** MarkCodeInfo +**Type:** MarkCodeInfo **Details:** @@ -340,7 +340,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Режим обработки кода маркировки (тег в 54 ФЗ — 2102) -**Type:** string +**Type:** string **Details:** @@ -352,7 +352,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Дробное количество маркированного товара (тег в 54 ФЗ — 1291) -**Type:** MarkQuantity +**Type:** MarkQuantity **Details:** @@ -364,7 +364,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Мера количества предмета расчета (тег в 54 ФЗ — 2108) -**Type:** string +**Type:** string **Details:** @@ -376,7 +376,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Признак способа расчета (тег в 54 ФЗ — 1214) -**Type:** string +**Type:** string **Details:** @@ -388,7 +388,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Признак предмета расчета (тег в 54 ФЗ — 1212) -**Type:** string +**Type:** string **Details:** @@ -400,7 +400,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -412,7 +412,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Признак способа расчета (тег в 54 ФЗ — 1214) -**Type:** string +**Type:** string **Details:** @@ -424,7 +424,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Признак предмета расчета (тег в 54 ФЗ — 1212) -**Type:** string +**Type:** string **Details:** @@ -436,7 +436,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -448,7 +448,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Цена товара (тег в 54 ФЗ — 1079) -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -460,7 +460,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код товара (тег в 54 ФЗ — 1162) -**Type:** string +**Type:** string **Details:** @@ -472,7 +472,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Код товара (тег в 54 ФЗ — 1162) -**Type:** string +**Type:** string **Details:** @@ -484,7 +484,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Количество (тег в 54 ФЗ — 1023) -**Type:** float +**Type:** float **Details:** @@ -496,7 +496,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224) -**Type:** Supplier +**Type:** Supplier **Details:** @@ -508,7 +508,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Ставка НДС (тег в 54 ФЗ — 1199), число 1-6 -**Type:** int +**Type:** int **Details:** @@ -520,7 +520,7 @@ ADD_PROPS_MAX_LENGTH = 64 : int Ставка НДС (тег в 54 ФЗ — 1199), число 1-6 -**Type:** int +**Type:** int **Details:** @@ -1081,10 +1081,6 @@ public isShipping() : bool public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) @@ -1096,92 +1092,76 @@ public jsonSerialize() : array | inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1702,11 +1682,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptItemInterface.md b/docs/classes/YooKassa-Model-ReceiptItemInterface.md index 31701e20..e4bf0b83 100644 --- a/docs/classes/YooKassa-Model-ReceiptItemInterface.md +++ b/docs/classes/YooKassa-Model-ReceiptItemInterface.md @@ -431,11 +431,11 @@ public isShipping() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md b/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md index 0f63446a..b9ef675c 100644 --- a/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md +++ b/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md @@ -10,19 +10,17 @@ **Description:** Состояние регистрации фискального чека: - +- `pending` - Чек ожидает доставки +- `succeeded` - Успешно доставлен +- `canceled` - Чек не доставлен --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [PENDING](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_PENDING) | | | -| public | [SUCCEEDED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_SUCCEEDED) | | | -| public | [CANCELED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_CANCELED) | | | +| public | [PENDING](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_PENDING) | | Состояние регистрации фискального чека: ожидает доставки | +| public | [SUCCEEDED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_SUCCEEDED) | | Состояние регистрации фискального чека: успешно доставлен | +| public | [CANCELED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_CANCELED) | | Состояние регистрации фискального чека: не доставлен | --- ### Properties @@ -41,7 +39,7 @@ --- ### Details * File: [lib/Model/ReceiptRegistrationStatus.php](../../lib/Model/ReceiptRegistrationStatus.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\ReceiptRegistrationStatus @@ -50,22 +48,28 @@ ## Constants ###### PENDING +Состояние регистрации фискального чека: ожидает доставки + ```php -PENDING = 'pending' : string +PENDING = 'pending' ``` ###### SUCCEEDED +Состояние регистрации фискального чека: успешно доставлен + ```php -SUCCEEDED = 'succeeded' : string +SUCCEEDED = 'succeeded' ``` ###### CANCELED +Состояние регистрации фискального чека: не доставлен + ```php -CANCELED = 'canceled' : string +CANCELED = 'canceled' ``` @@ -75,7 +79,7 @@ CANCELED = 'canceled' : string #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -150,11 +154,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptType.md b/docs/classes/YooKassa-Model-ReceiptType.md index 84babd20..22dbc313 100644 --- a/docs/classes/YooKassa-Model-ReceiptType.md +++ b/docs/classes/YooKassa-Model-ReceiptType.md @@ -9,19 +9,18 @@ ReceiptType - Тип чека в онлайн-кассе. **Description:** -|Код|Описание| ---- | --- -|payment|Приход| -|refund|Возврат| -|simple|Простой| +Возможные значения: +- `payment` - Приход +- `refund` - Возврат +- `simple` - Простой --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [PAYMENT](../classes/YooKassa-Model-ReceiptType.md#constant_PAYMENT) | | | -| public | [REFUND](../classes/YooKassa-Model-ReceiptType.md#constant_REFUND) | | | -| public | [SIMPLE](../classes/YooKassa-Model-ReceiptType.md#constant_SIMPLE) | | | +| public | [PAYMENT](../classes/YooKassa-Model-ReceiptType.md#constant_PAYMENT) | | Тип чека: приход | +| public | [REFUND](../classes/YooKassa-Model-ReceiptType.md#constant_REFUND) | | Тип чека: возврат | +| public | [SIMPLE](../classes/YooKassa-Model-ReceiptType.md#constant_SIMPLE) | | Тип чека: простой | --- ### Properties @@ -40,7 +39,7 @@ ReceiptType - Тип чека в онлайн-кассе. --- ### Details * File: [lib/Model/ReceiptType.php](../../lib/Model/ReceiptType.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\ReceiptType @@ -49,22 +48,28 @@ ReceiptType - Тип чека в онлайн-кассе. ## Constants ###### PAYMENT +Тип чека: приход + ```php -PAYMENT = 'payment' : string +PAYMENT = 'payment' ``` ###### REFUND +Тип чека: возврат + ```php -REFUND = 'refund' : string +REFUND = 'refund' ``` ###### SIMPLE +Тип чека: простой + ```php -SIMPLE = 'simple' : string +SIMPLE = 'simple' ``` @@ -74,7 +79,7 @@ SIMPLE = 'simple' : string #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -149,11 +154,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Recipient.md b/docs/classes/YooKassa-Model-Recipient.md index 82646069..ca09f99b 100644 --- a/docs/classes/YooKassa-Model-Recipient.md +++ b/docs/classes/YooKassa-Model-Recipient.md @@ -37,11 +37,11 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAccountId()](../classes/YooKassa-Model-Recipient.md#method_getAccountId) | | Возвращает идентификатор магазина | | public | [getGatewayId()](../classes/YooKassa-Model-Recipient.md#method_getGatewayId) | | Возвращает идентификатор шлюза. | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountId()](../classes/YooKassa-Model-Recipient.md#method_setAccountId) | | Устанавливает идентификатор магазина | | public | [setGatewayId()](../classes/YooKassa-Model-Recipient.md#method_setGatewayId) | | Устанавливает идентификатор шлюза | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -50,7 +50,7 @@ --- ### Details * File: [lib/Model/Recipient.php](../../lib/Model/Recipient.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Recipient @@ -66,7 +66,7 @@ Идентификатор магазина -**Type:** string +**Type:** string **Details:** @@ -78,7 +78,7 @@ Идентификатор магазина -**Type:** string +**Type:** string **Details:** @@ -90,7 +90,7 @@ Идентификатор шлюза -**Type:** string +**Type:** string **Details:** @@ -102,7 +102,7 @@ Идентификатор шлюза -**Type:** string +**Type:** string **Details:** @@ -282,109 +282,89 @@ public getGatewayId() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -489,11 +469,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RecipientInterface.md b/docs/classes/YooKassa-Model-RecipientInterface.md index 282c583a..a71fe2dc 100644 --- a/docs/classes/YooKassa-Model-RecipientInterface.md +++ b/docs/classes/YooKassa-Model-RecipientInterface.md @@ -26,7 +26,7 @@ --- ### Details * File: [lib/Model/RecipientInterface.php](../../lib/Model/RecipientInterface.php) -* Package: \Default +* Package: \YooKassa --- ### Tags @@ -89,11 +89,11 @@ public getGatewayId() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Refund.md b/docs/classes/YooKassa-Model-Refund.md index 4943ca59..c834dbc8 100644 --- a/docs/classes/YooKassa-Model-Refund.md +++ b/docs/classes/YooKassa-Model-Refund.md @@ -48,11 +48,11 @@ | public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | *deprecated* | | | public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | | public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | | public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | | public | [setDeal()](../classes/YooKassa-Model-Refund.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат. | @@ -69,7 +69,7 @@ --- ### Details * File: [lib/Model/Refund.php](../../lib/Model/Refund.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Refund @@ -85,7 +85,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -121,7 +121,7 @@ Данные о сделке, в составе которой проходит возврат -**Type:** RefundDealInfo +**Type:** RefundDealInfo **Details:** @@ -133,7 +133,7 @@ Комментарий, основание для возврата средств покупателю -**Type:** string +**Type:** string **Details:** @@ -145,7 +145,7 @@ Идентификатор возврата платежа -**Type:** string +**Type:** string **Details:** @@ -157,7 +157,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** @@ -169,7 +169,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** @@ -181,7 +181,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** @@ -193,7 +193,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** @@ -205,7 +205,7 @@ Статус возврата -**Type:** string +**Type:** string **Details:** @@ -519,109 +519,89 @@ public getStatus() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -939,11 +919,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RefundInterface.md b/docs/classes/YooKassa-Model-RefundInterface.md index a5264019..f0ec2141 100644 --- a/docs/classes/YooKassa-Model-RefundInterface.md +++ b/docs/classes/YooKassa-Model-RefundInterface.md @@ -213,11 +213,11 @@ public getDeal() : \YooKassa\Model\Deal\RefundDealInfo ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RefundStatus.md b/docs/classes/YooKassa-Model-RefundStatus.md index 6ead1336..dcccfff6 100644 --- a/docs/classes/YooKassa-Model-RefundStatus.md +++ b/docs/classes/YooKassa-Model-RefundStatus.md @@ -6,12 +6,13 @@ **Summary:** RefundStatus - Состояние возврата платежа -|Код|Описание| ---- | --- -|pending|Ожидает обработки| -|succeeded|Успешно возвращен| -|canceled|В проведении возврата отказано| +**Description:** + +Возможные значения: +- `pending` - Ожидает обработки +- `succeeded` - Успешно возвращен +- `canceled` - В проведении возврата отказано --- ### Constants @@ -38,7 +39,7 @@ RefundStatus - Состояние возврата платежа --- ### Details * File: [lib/Model/RefundStatus.php](../../lib/Model/RefundStatus.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\RefundStatus @@ -72,7 +73,7 @@ CANCELED = 'canceled' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -147,11 +148,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Requestor.md b/docs/classes/YooKassa-Model-Requestor.md index efa93d71..27cddb21 100644 --- a/docs/classes/YooKassa-Model-Requestor.md +++ b/docs/classes/YooKassa-Model-Requestor.md @@ -42,11 +42,11 @@ | public | [getClientId()](../classes/YooKassa-Model-Requestor.md#method_getClientId) | | Возвращает идентификатор приложения | | public | [getClientName()](../classes/YooKassa-Model-Requestor.md#method_getClientName) | | Возвращает название приложения | | public | [getType()](../classes/YooKassa-Model-Requestor.md#method_getType) | | Возвращает тип инициатора | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountId()](../classes/YooKassa-Model-Requestor.md#method_setAccountId) | | Устанавливает идентификатор магазина | | public | [setClientId()](../classes/YooKassa-Model-Requestor.md#method_setClientId) | | Устанавливает идентификатор приложения | | public | [setClientName()](../classes/YooKassa-Model-Requestor.md#method_setClientName) | | Устанавливает название приложения | @@ -79,7 +79,7 @@ Идентификатор магазина -**Type:** string +**Type:** string **Details:** @@ -91,7 +91,7 @@ Идентификатор магазина -**Type:** string +**Type:** string **Details:** @@ -103,7 +103,7 @@ Идентификатор приложения -**Type:** string +**Type:** string **Details:** @@ -115,7 +115,7 @@ Название приложения (только для type = RequestorThirdPartyService) -**Type:** string +**Type:** string **Details:** @@ -127,7 +127,7 @@ Идентификатор приложения -**Type:** string +**Type:** string **Details:** @@ -139,7 +139,7 @@ Название приложения (только для type = RequestorThirdPartyService) -**Type:** string +**Type:** string **Details:** @@ -151,7 +151,7 @@ Тип инициатора -**Type:** string +**Type:** string **Details:** @@ -377,109 +377,89 @@ public getType() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -632,11 +612,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RequestorInterface.md b/docs/classes/YooKassa-Model-RequestorInterface.md index 210c010f..66beda1e 100644 --- a/docs/classes/YooKassa-Model-RequestorInterface.md +++ b/docs/classes/YooKassa-Model-RequestorInterface.md @@ -212,11 +212,11 @@ public setClientName(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SafeDeal.md b/docs/classes/YooKassa-Model-SafeDeal.md index be842f26..b502d8d1 100644 --- a/docs/classes/YooKassa-Model-SafeDeal.md +++ b/docs/classes/YooKassa-Model-SafeDeal.md @@ -35,11 +35,11 @@ Class SafeBaseDeal | public | [getStatus()](../classes/YooKassa-Model-SafeDeal.md#method_getStatus) | | Возвращает статус сделки | | public | [getTest()](../classes/YooKassa-Model-SafeDeal.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setBalance) | | Устанавливает баланс сделки | | public | [setCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_setCreatedAt) | | Устанавливает время создания сделки | | public | [setDescription()](../classes/YooKassa-Model-SafeDeal.md#method_setDescription) | | Устанавливает описание сделки (не более 128 символов). | @@ -440,109 +440,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -853,11 +833,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployed.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployed.md new file mode 100644 index 00000000..3151410b --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployed.md @@ -0,0 +1,732 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployed +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployed. + +**Description:** + +Объект самозанятого. + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_confirmation) | | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | +| public | [$created_at](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_created_at) | | Время создания объекта самозанятого. | +| public | [$createdAt](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_createdAt) | | Время создания объекта самозанятого. | +| public | [$id](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_id) | | Идентификатор самозанятого в ЮKassa. | +| public | [$itn](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_itn) | | ИНН самозанятого. | +| public | [$phone](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_phone) | | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | +| public | [$status](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_status) | | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | +| public | [$test](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_test) | | Признак тестовой операции. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getConfirmation) | | Возвращает сценарий подтверждения. | +| public | [getCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getCreatedAt) | | Возвращает время создания объекта самозанятого | +| public | [getId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getId) | | Возвращает id. | +| public | [getItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getItn) | | Возвращает ИНН самозанятого | +| public | [getPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getPhone) | | Возвращает телефон самозанятого. | +| public | [getStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getStatus) | | Возвращает статус самозанятого. | +| public | [getTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getTest) | | Возвращает признак тестовой операции. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setConfirmation) | | Устанавливает сценарий подтверждения. | +| public | [setCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setCreatedAt) | | Устанавливает время создания объекта самозанятого | +| public | [setId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setId) | | Устанавливает идентификатор самозанятого. | +| public | [setItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setItn) | | Устанавливает ИНН самозанятого | +| public | [setPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setPhone) | | Устанавливает телефон самозанятого. | +| public | [setStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setStatus) | | Устанавливает статус самозанятого. | +| public | [setTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setTest) | | Устанавливает признак тестовой операции. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployed.php](../../lib/Model/SelfEmployed/SelfEmployed.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\SelfEmployed\SelfEmployed +* Implements: + * [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $confirmation : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null +--- +***Description*** + +Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. + +**Type:** SelfEmployedConfirmation|null + +**Details:** + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания объекта самозанятого. + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания объекта самозанятого. + +**Type:** \DateTime + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор самозанятого в ЮKassa. + +**Type:** string + +**Details:** + + + +#### public $itn : string|null +--- +***Description*** + +ИНН самозанятого. + +**Type:** string|null + +**Details:** + + + +#### public $phone : string|null +--- +***Description*** + +Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. + +**Type:** string|null + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. + +**Type:** string + +**Details:** + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции. + +**Type:** bool + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null + +```php +public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null +``` + +**Summary** + +Возвращает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null - Сценарий подтверждения + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** \DateTime - Время создания объекта самозанятого + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает id. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string - + + + +#### public getItn() : string|null + +```php +public getItn() : string|null +``` + +**Summary** + +Возвращает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string|null - ИНН самозанятого + + + +#### public getPhone() : string|null + +```php +public getPhone() : string|null +``` + +**Summary** + +Возвращает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string|null - Телефон самозанятого + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string - Статус самозанятого + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** bool - Признак тестовой операции. + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setConfirmation() : $this + +```php +public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this +``` + +**Summary** + +Устанавливает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null | confirmation | Сценарий подтверждения | + +**Returns:** $this - + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания объекта самозанятого | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** $this - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор самозанятого в ЮKassa. | + +**Returns:** $this - + + + +#### public setItn() : $this + +```php +public setItn(string|null $itn = null) : $this +``` + +**Summary** + +Устанавливает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | itn | ИНН самозанятого | + +**Returns:** $this - + + + +#### public setPhone() : $this + +```php +public setPhone(string|null $phone = null) : $this +``` + +**Summary** + +Устанавливает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | phone | Телефон самозанятого | + +**Returns:** $this - + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус самозанятого | + +**Returns:** $this - + + + +#### public setTest() : $this + +```php +public setTest(bool $test) : $this +``` + +**Summary** + +Устанавливает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md new file mode 100644 index 00000000..bb3b4d8a --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md @@ -0,0 +1,383 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedConfirmation. + + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#property_type) | | Тип сценария подтверждения. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#method_getType) | | Возвращает тип сценария подтверждения | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#method_setType) | | Устанавливает тип сценария подтверждения | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedConfirmation.php](../../lib/Model/SelfEmployed/SelfEmployedConfirmation.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип сценария подтверждения. + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md new file mode 100644 index 00000000..63c93f1b --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md @@ -0,0 +1,94 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationFactory +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Class ConfirmationFactory + + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md#method_factory) | | Возвращает объект, соответствующий типу подтверждения платежа | +| public | [factoryFromArray()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md#method_factoryFromArray) | | Возвращает объект, соответствующий типу подтверждения платежа, из массива данных | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedConfirmationFactory.php](../../lib/Model/SelfEmployed/SelfEmployedConfirmationFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation + +```php +public factory(string $type) : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationFactory](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation - + + + +#### public factoryFromArray() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation + +```php +public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationFactory](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив данных подтверждения платежа | +| string OR null | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md new file mode 100644 index 00000000..15f9d7de --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md @@ -0,0 +1,446 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedConfirmationRedirect. + +**Description:** + +Перенаправление пользователя на сайт сервиса Мой налог для выдачи прав ЮMoney. + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation_url](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md#property_confirmation_url) | | URL на который необходимо перенаправить плательщика для подтверждения оплаты | +| public | [$confirmationUrl](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md#property_confirmationUrl) | | URL на который необходимо перенаправить плательщика для подтверждения оплаты | +| public | [$type](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#property_type) | | Тип сценария подтверждения. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md#method_getConfirmationUrl) | | Возвращает confirmation_url. | +| public | [getType()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#method_getType) | | Возвращает тип сценария подтверждения | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setConfirmationUrl()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md#method_setConfirmationUrl) | | Устанавливает confirmation_url. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md#method_setType) | | Устанавливает тип сценария подтверждения | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedConfirmationRedirect.php](../../lib/Model/SelfEmployed/SelfEmployedConfirmationRedirect.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + * \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $confirmation_url : string +--- +***Description*** + +URL на который необходимо перенаправить плательщика для подтверждения оплаты + +**Type:** string + +**Details:** + + + +#### public $confirmationUrl : string +--- +***Description*** + +URL на который необходимо перенаправить плательщика для подтверждения оплаты + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип сценария подтверждения. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationUrl() : string|null + +```php +public getConfirmationUrl() : string|null +``` + +**Summary** + +Возвращает confirmation_url. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md) + +**Returns:** string|null - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setConfirmationUrl() : $this + +```php +public setConfirmationUrl(string|null $confirmation_url) : $this +``` + +**Summary** + +Устанавливает confirmation_url. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | confirmation_url | URL, на который необходимо перенаправить самозанятого для выдачи прав. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md new file mode 100644 index 00000000..7e358423 --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md @@ -0,0 +1,147 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationType +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedConfirmationType. + +**Description:** + +Код сценария подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [REDIRECT](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md#constant_REDIRECT) | | Необходимо направить плательщика на страницу партнера | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedConfirmationType.php](../../lib/Model/SelfEmployed/SelfEmployedConfirmationType.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationType + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### REDIRECT +Необходимо направить плательщика на страницу партнера + +```php +REDIRECT = 'redirect' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md new file mode 100644 index 00000000..0bfc0be5 --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md @@ -0,0 +1,377 @@ +# [YooKassa API SDK](../home.md) + +# Interface: SelfEmployedInterface +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployed. + +**Description:** + +Объект самозанятого. + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +* [public MIN_LENGTH_ID](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#constant_MIN_LENGTH_ID) +* [public MAX_LENGTH_ID](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#constant_MAX_LENGTH_ID) + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getConfirmation) | | Возвращает сценарий подтверждения. | +| public | [getCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getCreatedAt) | | Возвращает время создания объекта самозанятого | +| public | [getId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getId) | | Возвращает идентификатор самозанятого. | +| public | [getItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getItn) | | Возвращает ИНН самозанятого | +| public | [getPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getPhone) | | Возвращает телефон самозанятого. | +| public | [getStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getStatus) | | Возвращает статус самозанятого. | +| public | [getTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_getTest) | | Возвращает признак тестовой операции. | +| public | [setConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setConfirmation) | | Устанавливает сценарий подтверждения. | +| public | [setCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setCreatedAt) | | Устанавливает время создания объекта самозанятого | +| public | [setId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setId) | | Устанавливает идентификатор самозанятого. | +| public | [setItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setItn) | | Устанавливает ИНН самозанятого | +| public | [setPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setPhone) | | Устанавливает телефон самозанятого. | +| public | [setStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setStatus) | | Устанавливает статус самозанятого. | +| public | [setTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md#method_setTest) | | Устанавливает признак тестовой операции. | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedInterface.php](../../lib/Model/SelfEmployed/SelfEmployedInterface.php) +* Package: \YooKassa\Model + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | +| property | | Идентификатор самозанятого в ЮKassa. | +| property | | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | +| property | | Время создания объекта самозанятого. | +| property | | Время создания объекта самозанятого. | +| property | | ИНН самозанятого. | +| property | | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | +| property | | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | +| property | | Идентификатор самозанятого в ЮKassa. | + +--- +## Constants + +###### MIN_LENGTH_ID +```php +MIN_LENGTH_ID = 36 : int +``` + + + +###### MAX_LENGTH_ID +```php +MAX_LENGTH_ID = 50 : int +``` + + + +--- +## Methods + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** string - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор самозанятого в ЮKassa | + +**Returns:** $this - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** string - Статус самозанятого + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус самозанятого | + +**Returns:** $this - + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** \DateTime - Время создания объекта самозанятого + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания объекта самозанятого | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** $this - + + + +#### public getItn() : string|null + +```php +public getItn() : string|null +``` + +**Summary** + +Возвращает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** string|null - ИНН самозанятого + + + +#### public setItn() : $this + +```php +public setItn(string|null $itn = null) : $this +``` + +**Summary** + +Устанавливает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | itn | ИНН самозанятого | + +**Returns:** $this - + + + +#### public getPhone() : string|null + +```php +public getPhone() : string|null +``` + +**Summary** + +Возвращает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** string|null - Телефон самозанятого + + + +#### public setPhone() : $this + +```php +public setPhone(string|null $phone = null) : $this +``` + +**Summary** + +Устанавливает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | phone | Телефон самозанятого | + +**Returns:** $this - + + + +#### public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null + +```php +public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null +``` + +**Summary** + +Возвращает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null - Сценарий подтверждения + + + +#### public setConfirmation() : $this + +```php +public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this +``` + +**Summary** + +Устанавливает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null | confirmation | Сценарий подтверждения | + +**Returns:** $this - + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +**Returns:** bool - Признак тестовой операции. + + + +#### public setTest() : $this + +```php +public setTest(bool $test) : $this +``` + +**Summary** + +Устанавливает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции. | + +**Returns:** $this - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md new file mode 100644 index 00000000..f8f122ab --- /dev/null +++ b/docs/classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md @@ -0,0 +1,172 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\SelfEmployed\SelfEmployedStatus +### Namespace: [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedStatus. + +**Description:** + +Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. + +Возможные значения: +- `pending` — ЮMoney запросили права на регистрацию чеков, но самозанятый еще не ответил на заявку; +- `confirmed` — самозанятый выдал права ЮMoney; вы можете делать выплаты; +- `canceled` — самозанятый отклонил заявку или отозвал ранее выданные права. + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PENDING](../classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md#constant_PENDING) | | ЮMoney запросили права на регистрацию чеков, но самозанятый еще не ответил на заявку | +| public | [CONFIRMED](../classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md#constant_CONFIRMED) | | Самозанятый выдал права ЮMoney, вы можете делать выплаты | +| public | [CANCELED](../classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md#constant_CANCELED) | | Самозанятый отклонил заявку или отозвал ранее выданные права | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md#property_validValues) | | | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | + +--- +### Details +* File: [lib/Model/SelfEmployed/SelfEmployedStatus.php](../../lib/Model/SelfEmployed/SelfEmployedStatus.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\SelfEmployed\SelfEmployedStatus + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### PENDING +ЮMoney запросили права на регистрацию чеков, но самозанятый еще не ответил на заявку + +```php +PENDING = 'pending' +``` + + + +###### CONFIRMED +Самозанятый выдал права ЮMoney, вы можете делать выплаты + +```php +CONFIRMED = 'confirmed' +``` + + + +###### CANCELED +Самозанятый отклонил заявку или отозвал ранее выданные права + +```php +CANCELED = 'canceled' +``` + + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed $value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Settlement.md b/docs/classes/YooKassa-Model-Settlement.md index 8bc488c5..00519431 100644 --- a/docs/classes/YooKassa-Model-Settlement.md +++ b/docs/classes/YooKassa-Model-Settlement.md @@ -31,11 +31,11 @@ Class Settlement | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAmount()](../classes/YooKassa-Model-Settlement.md#method_getAmount) | | Возвращает размер оплаты | | public | [getType()](../classes/YooKassa-Model-Settlement.md#method_getType) | | Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Settlement.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setType()](../classes/YooKassa-Model-Settlement.md#method_setType) | | Устанавливает вид оплаты в чеке | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -60,7 +60,7 @@ Class Settlement Размер оплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -72,7 +72,7 @@ Class Settlement Вид оплаты в чеке -**Type:** string +**Type:** string **Details:** @@ -248,109 +248,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -443,11 +423,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SettlementInterface.md b/docs/classes/YooKassa-Model-SettlementInterface.md index 30e58717..a965c86d 100644 --- a/docs/classes/YooKassa-Model-SettlementInterface.md +++ b/docs/classes/YooKassa-Model-SettlementInterface.md @@ -78,11 +78,11 @@ public getAmount() : \YooKassa\Model\AmountInterface ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Source.md b/docs/classes/YooKassa-Model-Source.md index 705110c5..cdf83e5e 100644 --- a/docs/classes/YooKassa-Model-Source.md +++ b/docs/classes/YooKassa-Model-Source.md @@ -35,11 +35,11 @@ | public | [getPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | | public | [hasAmount()](../classes/YooKassa-Model-Source.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты | | public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_hasPlatformFeeAmount) | | Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountId()](../classes/YooKassa-Model-Source.md#method_setAccountId) | | Устаналивает id магазина-получателя средств | | public | [setAmount()](../classes/YooKassa-Model-Source.md#method_setAmount) | | Устанавливает сумму оплаты | | public | [setPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | @@ -49,7 +49,7 @@ --- ### Details * File: [lib/Model/Source.php](../../lib/Model/Source.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\Source @@ -65,7 +65,7 @@ Идентификатор магазина, для которого вы хотите провести возврат -**Type:** string +**Type:** string **Details:** @@ -77,7 +77,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -89,7 +89,7 @@ Комиссия, которую вы удержали при оплате, и хотите вернуть -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -336,109 +336,89 @@ public hasPlatformFeeAmount() : bool | inheritDoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -565,11 +545,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SourceInterface.md b/docs/classes/YooKassa-Model-SourceInterface.md index 9e46c676..ad446367 100644 --- a/docs/classes/YooKassa-Model-SourceInterface.md +++ b/docs/classes/YooKassa-Model-SourceInterface.md @@ -202,11 +202,11 @@ public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array $value) : mixe ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Supplier.md b/docs/classes/YooKassa-Model-Supplier.md index 13fb0ea5..4c3191a1 100644 --- a/docs/classes/YooKassa-Model-Supplier.md +++ b/docs/classes/YooKassa-Model-Supplier.md @@ -36,11 +36,11 @@ | public | [getInn()](../classes/YooKassa-Model-Supplier.md#method_getInn) | | Возвращает ИНН пользователя (10 или 12 цифр) | | public | [getName()](../classes/YooKassa-Model-Supplier.md#method_getName) | | Возвращает наименование поставщика | | public | [getPhone()](../classes/YooKassa-Model-Supplier.md#method_getPhone) | | Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setInn()](../classes/YooKassa-Model-Supplier.md#method_setInn) | | Устанавливает ИНН пользователя (10 или 12 цифр) | | public | [setName()](../classes/YooKassa-Model-Supplier.md#method_setName) | | Устанавливает наименование поставщика | | public | [setPhone()](../classes/YooKassa-Model-Supplier.md#method_setPhone) | | Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 | @@ -66,7 +66,7 @@ ИНН пользователя (10 или 12 цифр) -**Type:** string +**Type:** string **Details:** @@ -78,7 +78,7 @@ Наименование поставщика -**Type:** string +**Type:** string **Details:** @@ -90,7 +90,7 @@ Телефон пользователя. Указывается в формате ITU-T E.164 -**Type:** string +**Type:** string **Details:** @@ -283,109 +283,89 @@ public getPhone() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -500,11 +480,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SupplierInterface.md b/docs/classes/YooKassa-Model-SupplierInterface.md index 6eea4b7b..3fc887f5 100644 --- a/docs/classes/YooKassa-Model-SupplierInterface.md +++ b/docs/classes/YooKassa-Model-SupplierInterface.md @@ -142,7 +142,7 @@ public getInn() : string|null #### public setInn() : mixed ```php -public setInn($value) : mixed +public setInn(string|null $value) : mixed ``` **Summary** @@ -155,7 +155,7 @@ public setInn($value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| | value | ИНН пользователя | +| string OR null | value | ИНН пользователя | **Returns:** mixed - @@ -172,11 +172,11 @@ public setInn($value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ThreeDSecure.md b/docs/classes/YooKassa-Model-ThreeDSecure.md index a3212443..9bea1943 100644 --- a/docs/classes/YooKassa-Model-ThreeDSecure.md +++ b/docs/classes/YooKassa-Model-ThreeDSecure.md @@ -29,11 +29,11 @@ ThreeDSecure - Данные о прохождении пользователем | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getApplied()](../classes/YooKassa-Model-ThreeDSecure.md#method_getApplied) | | Возвращает признак отображения пользователю формы для прохождения аутентификации по 3‑D Secure | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setApplied()](../classes/YooKassa-Model-ThreeDSecure.md#method_setApplied) | | Устанавливает признак отображения пользователю формы для прохождения аутентификации по 3‑D Secure | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -41,7 +41,7 @@ ThreeDSecure - Данные о прохождении пользователем --- ### Details * File: [lib/Model/ThreeDSecure.php](../../lib/Model/ThreeDSecure.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Model\ThreeDSecure @@ -55,7 +55,7 @@ ThreeDSecure - Данные о прохождении пользователем Отображение пользователю формы для прохождения аутентификации по 3‑D Secure. -**Type:** bool +**Type:** bool **Details:** @@ -214,109 +214,89 @@ public getApplied() : bool|null -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -392,11 +372,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Transfer.md b/docs/classes/YooKassa-Model-Transfer.md index 0c9b0954..5e3e7328 100644 --- a/docs/classes/YooKassa-Model-Transfer.md +++ b/docs/classes/YooKassa-Model-Transfer.md @@ -25,7 +25,7 @@ | public | [$accountId](../classes/YooKassa-Model-Transfer.md#property_accountId) | | Идентификатор магазина, в пользу которого вы принимаете оплату | | public | [$amount](../classes/YooKassa-Model-Transfer.md#property_amount) | | Сумма, которую необходимо перечислить магазину | | public | [$description](../classes/YooKassa-Model-Transfer.md#property_description) | | Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») | -| public | [$metadata](../classes/YooKassa-Model-Transfer.md#property_metadata) | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) | +| public | [$metadata](../classes/YooKassa-Model-Transfer.md#property_metadata) | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) | | public | [$platform_fee_amount](../classes/YooKassa-Model-Transfer.md#property_platform_fee_amount) | | Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | | public | [$status](../classes/YooKassa-Model-Transfer.md#property_status) | | Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` | @@ -49,11 +49,11 @@ | public | [hasDescription()](../classes/YooKassa-Model-Transfer.md#method_hasDescription) | | Проверяет, было ли установлено описание транзакции | | public | [hasMetadata()](../classes/YooKassa-Model-Transfer.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные | | public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_hasPlatformFeeAmount) | | Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountId()](../classes/YooKassa-Model-Transfer.md#method_setAccountId) | | Устанавливает идентификатор магазина-получателя средств | | public | [setAmount()](../classes/YooKassa-Model-Transfer.md#method_setAmount) | | Устанавливает сумму оплаты | | public | [setDescription()](../classes/YooKassa-Model-Transfer.md#method_setDescription) | | Устанавливает описание транзакции | @@ -94,7 +94,7 @@ MAX_LENGTH_DESCRIPTION = 128 Идентификатор магазина, в пользу которого вы принимаете оплату -**Type:** string +**Type:** string **Details:** @@ -106,7 +106,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сумма, которую необходимо перечислить магазину -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -118,7 +118,7 @@ MAX_LENGTH_DESCRIPTION = 128 Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») -**Type:** string +**Type:** string **Details:** @@ -128,9 +128,9 @@ MAX_LENGTH_DESCRIPTION = 128 --- ***Description*** -Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) +Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) -**Type:** Metadata +**Type:** Metadata **Details:** @@ -142,7 +142,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -154,7 +154,7 @@ MAX_LENGTH_DESCRIPTION = 128 Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` -**Type:** string +**Type:** string **Details:** @@ -506,109 +506,89 @@ public hasPlatformFeeAmount() : bool | inheritDoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -809,11 +789,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-TransferInterface.md b/docs/classes/YooKassa-Model-TransferInterface.md index 2c2a2bb4..db2cea30 100644 --- a/docs/classes/YooKassa-Model-TransferInterface.md +++ b/docs/classes/YooKassa-Model-TransferInterface.md @@ -51,7 +51,7 @@ Interface TransferInterface | property | | Идентификатор магазина, в пользу которого вы принимаете оплату | | property | | Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` | | property | | Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») | -| property | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) | +| property | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) | --- ## Methods @@ -369,11 +369,11 @@ public hasMetadata() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-TransferStatus.md b/docs/classes/YooKassa-Model-TransferStatus.md index 1f4e9f05..c62b3236 100644 --- a/docs/classes/YooKassa-Model-TransferStatus.md +++ b/docs/classes/YooKassa-Model-TransferStatus.md @@ -6,22 +6,23 @@ **Summary:** PaymentStatus - Статус операции распределения средств конечному получателю -|Код|Описание| ---- | --- -|pending|Ожидает оплаты покупателем| -|waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| -|succeeded|Успешно оплачен и получен магазином| -|canceled|Неуспех оплаты или отменен магазином (cancel)| +**Description:** + +Возможные значения: +- `pending` - Ожидает оплаты покупателем +- `waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) +- `succeeded` - Успешно оплачен и получен магазином +- `canceled` - Неуспех оплаты или отменен магазином (cancel) --- ### Constants | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [PENDING](../classes/YooKassa-Model-TransferStatus.md#constant_PENDING) | | | -| public | [WAITING_FOR_CAPTURE](../classes/YooKassa-Model-TransferStatus.md#constant_WAITING_FOR_CAPTURE) | | | -| public | [SUCCEEDED](../classes/YooKassa-Model-TransferStatus.md#constant_SUCCEEDED) | | | -| public | [CANCELED](../classes/YooKassa-Model-TransferStatus.md#constant_CANCELED) | | | +| public | [PENDING](../classes/YooKassa-Model-TransferStatus.md#constant_PENDING) | | Ожидает оплаты покупателем | +| public | [WAITING_FOR_CAPTURE](../classes/YooKassa-Model-TransferStatus.md#constant_WAITING_FOR_CAPTURE) | | Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) | +| public | [SUCCEEDED](../classes/YooKassa-Model-TransferStatus.md#constant_SUCCEEDED) | | Успешно оплачен и получен магазином | +| public | [CANCELED](../classes/YooKassa-Model-TransferStatus.md#constant_CANCELED) | | Неуспех оплаты или отменен магазином (cancel) | --- ### Properties @@ -40,7 +41,7 @@ PaymentStatus - Статус операции распределения сре --- ### Details * File: [lib/Model/TransferStatus.php](../../lib/Model/TransferStatus.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) * \YooKassa\Model\TransferStatus @@ -49,6 +50,8 @@ PaymentStatus - Статус операции распределения сре ## Constants ###### PENDING +Ожидает оплаты покупателем + ```php PENDING = 'pending' ``` @@ -56,6 +59,8 @@ PENDING = 'pending' ###### WAITING_FOR_CAPTURE +Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) + ```php WAITING_FOR_CAPTURE = 'waiting_for_capture' ``` @@ -63,6 +68,8 @@ WAITING_FOR_CAPTURE = 'waiting_for_capture' ###### SUCCEEDED +Успешно оплачен и получен магазином + ```php SUCCEEDED = 'succeeded' ``` @@ -70,6 +77,8 @@ SUCCEEDED = 'succeeded' ###### CANCELED +Неуспех оплаты или отменен магазином (cancel) + ```php CANCELED = 'canceled' ``` @@ -81,7 +90,7 @@ CANCELED = 'canceled' #### protected $validValues : array --- -**Type:** array +**Type:** array Массив принимаемых enum'ом значений **Details:** @@ -156,11 +165,11 @@ Static public valueExists(mixed $value) : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Webhook-Webhook.md b/docs/classes/YooKassa-Model-Webhook-Webhook.md index 897b5e58..f2834f1e 100644 --- a/docs/classes/YooKassa-Model-Webhook-Webhook.md +++ b/docs/classes/YooKassa-Model-Webhook-Webhook.md @@ -33,11 +33,11 @@ | public | [getEvent()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getEvent) | | Возвращает событие, о котором уведомляет ЮKassa | | public | [getId()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getId) | | Возвращает идентификатор webhook | | public | [getUrl()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getUrl) | | Возвращает URL, на который ЮKassa будет отправлять уведомления | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setEvent()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setEvent) | | Устанавливает событие, о котором уведомляет ЮKassa | | public | [setId()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setId) | | Устанавливает идентификатор webhook | | public | [setUrl()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setUrl) | | Устанавливает URL, на который ЮKassa будет отправлять уведомления | @@ -61,7 +61,7 @@ Событие, о котором уведомляет ЮKassa -**Type:** string +**Type:** string **Details:** @@ -73,7 +73,7 @@ Идентификатор webhook -**Type:** string +**Type:** string **Details:** @@ -85,7 +85,7 @@ URL, на который ЮKassa будет отправлять уведомления -**Type:** string +**Type:** string **Details:** @@ -278,109 +278,89 @@ public getUrl() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -495,11 +475,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-AbstractDealResponse.md b/docs/classes/YooKassa-Request-Deals-AbstractDealResponse.md index 38028c51..15546bcb 100644 --- a/docs/classes/YooKassa-Request-Deals-AbstractDealResponse.md +++ b/docs/classes/YooKassa-Request-Deals-AbstractDealResponse.md @@ -35,11 +35,11 @@ | public | [getStatus()](../classes/YooKassa-Model-SafeDeal.md#method_getStatus) | | Возвращает статус сделки | | public | [getTest()](../classes/YooKassa-Model-SafeDeal.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setBalance) | | Устанавливает баланс сделки | | public | [setCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_setCreatedAt) | | Устанавливает время создания сделки | | public | [setDescription()](../classes/YooKassa-Model-SafeDeal.md#method_setDescription) | | Устанавливает описание сделки (не более 128 символов). | @@ -443,109 +443,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -856,11 +836,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-CreateDealRequest.md b/docs/classes/YooKassa-Request-Deals-CreateDealRequest.md index af93f702..a58966fd 100644 --- a/docs/classes/YooKassa-Request-Deals-CreateDealRequest.md +++ b/docs/classes/YooKassa-Request-Deals-CreateDealRequest.md @@ -43,11 +43,11 @@ | public | [hasFeeMoment()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_hasFeeMoment) | | Проверяет, был ли установлен момент перечисления вознаграждения | | public | [hasMetadata()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные заказа | | public | [hasType()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_hasType) | | Проверяет наличие типа в создаваемой сделке | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setDescription()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_setDescription) | | Устанавливает описание сделки | | public | [setFeeMoment()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_setFeeMoment) | | Устанавливает момент перечисления вам вознаграждения платформы | | public | [setMetadata()](../classes/YooKassa-Request-Deals-CreateDealRequest.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | @@ -83,7 +83,7 @@ Описание сделки -**Type:** string +**Type:** string **Details:** @@ -95,7 +95,7 @@ Момент перечисления вам вознаграждения платформы -**Type:** string +**Type:** string **Details:** @@ -107,7 +107,7 @@ Момент перечисления вам вознаграждения платформы -**Type:** string +**Type:** string **Details:** @@ -119,7 +119,7 @@ Метаданные привязанные к сделке -**Type:** Metadata +**Type:** Metadata **Details:** @@ -131,7 +131,7 @@ Тип сделки -**Type:** string +**Type:** string **Details:** @@ -460,109 +460,89 @@ public hasType() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -761,11 +741,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md b/docs/classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md index bfd92d7e..94051088 100644 --- a/docs/classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md @@ -10,87 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 11 78 Пример использования билдера ```php -try { - $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); - $builder->setAmount(100) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setCapture(true) - ->setDescription('Оплата заказа 112233') - ->setMetadata(array( - 'cms_name' => 'yoo_api_test', - 'order_id' => '112233', - 'language' => 'ru', - 'transaction_id' => '123-456-789', - )); - - // Устанавливаем страницу для редиректа после оплаты - $builder->setConfirmation(array( - 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, - 'returnUrl' => 'https://merchant-site.ru/payment-return-page', - )); - - // Можем установить конкретный способ оплаты - $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); - - // Составляем чек - $builder->setReceiptEmail('john.doe@merchant.com'); - $builder->setReceiptPhone('71111111111'); - // Добавим товар - $builder->addReceiptItem( - 'Платок Gucci', - 3000, - 1.0, - 2, - 'full_payment', - 'commodity' - ); - // Добавим доставку - $builder->addReceiptShipping( - 'Delivery/Shipping/Доставка', - 100, - 1, - \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, - \YooKassa\Model\Receipt\PaymentSubject::SERVICE - ); - - // Можно добавить распределение денег по магазинам - $builder->setTransfers(array( - array( - 'account_id' => 123456, - 'amount' => array( - array( - 'value' => 1000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ), - array( - 'account_id' => 654321, - 'amount' => array( - array( - 'value' => 2000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ) - )); - - // Создаем объект запроса - $request = $builder->build(); - - // Можно изменить данные, если нужно - $request->setDescription($request->getDescription() . ' - merchant comment'); - - $idempotenceKey = uniqid('', true); - $response = $client->createPayment($request, $idempotenceKey); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -134,7 +56,7 @@ var_dump($response); Собираемый объект запроса -**Type:** CreateDealRequest +**Type:** CreateDealRequest **Details:** @@ -348,11 +270,11 @@ protected initCurrentObject() : \YooKassa\Request\Deals\CreateDealRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-CreateDealRequestInterface.md b/docs/classes/YooKassa-Request-Deals-CreateDealRequestInterface.md index 729348ba..47f1384f 100644 --- a/docs/classes/YooKassa-Request-Deals-CreateDealRequestInterface.md +++ b/docs/classes/YooKassa-Request-Deals-CreateDealRequestInterface.md @@ -281,11 +281,11 @@ public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-CreateDealRequestSerializer.md b/docs/classes/YooKassa-Request-Deals-CreateDealRequestSerializer.md index 7ef48c73..ed8b929e 100644 --- a/docs/classes/YooKassa-Request-Deals-CreateDealRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Deals-CreateDealRequestSerializer.md @@ -31,7 +31,7 @@ #### public serialize() : array ```php -public serialize(\YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Common\AbstractRequest $request) : array +public serialize(\YooKassa\Request\Deals\CreateDealRequestInterface $request) : array ``` **Summary** @@ -44,7 +44,7 @@ public serialize(\YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Co ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Request\Deals\CreateDealRequestInterface OR \YooKassa\Common\AbstractRequest | request | Объект запроса | +| \YooKassa\Request\Deals\CreateDealRequestInterface | request | Объект запроса | **Returns:** array - Массив данных для дальнейшего кодирования в JSON @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Co ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md b/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md index f9676371..e1c3c34c 100644 --- a/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md +++ b/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md @@ -35,11 +35,11 @@ | public | [getStatus()](../classes/YooKassa-Model-SafeDeal.md#method_getStatus) | | Возвращает статус сделки | | public | [getTest()](../classes/YooKassa-Model-SafeDeal.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setBalance) | | Устанавливает баланс сделки | | public | [setCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_setCreatedAt) | | Устанавливает время создания сделки | | public | [setDescription()](../classes/YooKassa-Model-SafeDeal.md#method_setDescription) | | Устанавливает описание сделки (не более 128 символов). | @@ -442,109 +442,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -855,11 +835,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealResponse.md b/docs/classes/YooKassa-Request-Deals-DealResponse.md index e17596e2..292c9deb 100644 --- a/docs/classes/YooKassa-Request-Deals-DealResponse.md +++ b/docs/classes/YooKassa-Request-Deals-DealResponse.md @@ -35,11 +35,11 @@ | public | [getStatus()](../classes/YooKassa-Model-SafeDeal.md#method_getStatus) | | Возвращает статус сделки | | public | [getTest()](../classes/YooKassa-Model-SafeDeal.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setBalance) | | Устанавливает баланс сделки | | public | [setCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_setCreatedAt) | | Устанавливает время создания сделки | | public | [setDescription()](../classes/YooKassa-Model-SafeDeal.md#method_setDescription) | | Устанавливает описание сделки (не более 128 символов). | @@ -442,109 +442,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -855,11 +835,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealsRequest.md b/docs/classes/YooKassa-Request-Deals-DealsRequest.md index 9109a222..d612634d 100644 --- a/docs/classes/YooKassa-Request-Deals-DealsRequest.md +++ b/docs/classes/YooKassa-Request-Deals-DealsRequest.md @@ -69,11 +69,11 @@ | public | [hasFullTextSearch()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_hasFullTextSearch) | | Проверяет, был ли установлен фильтр по описанию выбираемых сделок | | public | [hasLimit()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_hasLimit) | | Проверяет, было ли установлено ограничение количества объектов платежа | | public | [hasStatus()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_hasStatus) | | Проверяет, был ли установлен статус выбираемых сделок | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCreatedAtGt()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются платежи | | public | [setCreatedAtGte()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются платежи | | public | [setCreatedAtLt()](../classes/YooKassa-Request-Deals-DealsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются платежи | @@ -94,7 +94,7 @@ --- ### Details * File: [lib/Request/Deals/DealsRequest.php](../../lib/Request/Deals/DealsRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -132,7 +132,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время создания, от (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -144,7 +144,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время создания, от (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -156,7 +156,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время создания, до (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -168,7 +168,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время создания, до (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -180,7 +180,7 @@ MIN_LENGTH_DESCRIPTION = 4 Страница выдачи результатов, которую необходимо отобразить -**Type:** string|null +**Type:** string|null **Details:** @@ -192,7 +192,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время автоматического закрытия, от (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -204,7 +204,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время автоматического закрытия, от (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -216,7 +216,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время автоматического закрытия, до (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -228,7 +228,7 @@ MIN_LENGTH_DESCRIPTION = 4 Время автоматического закрытия, до (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -240,7 +240,7 @@ MIN_LENGTH_DESCRIPTION = 4 Фильтр по описанию сделки — параметру description -**Type:** string|null +**Type:** string|null **Details:** @@ -252,7 +252,7 @@ MIN_LENGTH_DESCRIPTION = 4 Ограничение количества объектов платежа, отображаемых на одной странице выдачи -**Type:** int|null +**Type:** int|null **Details:** @@ -264,7 +264,7 @@ MIN_LENGTH_DESCRIPTION = 4 Статус платежа -**Type:** string|null +**Type:** string|null **Details:** @@ -865,109 +865,89 @@ public hasStatus() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1389,11 +1369,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealsRequestBuilder.md b/docs/classes/YooKassa-Request-Deals-DealsRequestBuilder.md index 06f7d024..054e988f 100644 --- a/docs/classes/YooKassa-Request-Deals-DealsRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Deals-DealsRequestBuilder.md @@ -56,7 +56,7 @@ Инстанс собираемого запроса -**Type:** DealsRequest +**Type:** DealsRequest Собираемый объект запроса списка сделок магазина **Details:** @@ -493,11 +493,11 @@ protected initCurrentObject() : \YooKassa\Request\Deals\DealsRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealsRequestInterface.md b/docs/classes/YooKassa-Request-Deals-DealsRequestInterface.md index b046c195..0663c9cc 100644 --- a/docs/classes/YooKassa-Request-Deals-DealsRequestInterface.md +++ b/docs/classes/YooKassa-Request-Deals-DealsRequestInterface.md @@ -760,11 +760,11 @@ public setFullTextSearch(string $value) : void ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealsRequestSerializer.md b/docs/classes/YooKassa-Request-Deals-DealsRequestSerializer.md index 665f5fd8..369f76f9 100644 --- a/docs/classes/YooKassa-Request-Deals-DealsRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Deals-DealsRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Deals\DealsRequest|\YooKassa\Request\Deals\De ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Deals-DealsResponse.md b/docs/classes/YooKassa-Request-Deals-DealsResponse.md index 153f1bc0..01d7fcf1 100644 --- a/docs/classes/YooKassa-Request-Deals-DealsResponse.md +++ b/docs/classes/YooKassa-Request-Deals-DealsResponse.md @@ -25,11 +25,11 @@ | public | [getItems()](../classes/YooKassa-Request-Deals-DealsResponse.md#method_getItems) | | Возвращает список сделок | | public | [getNextCursor()](../classes/YooKassa-Request-Deals-DealsResponse.md#method_getNextCursor) | | Возвращает токен следующей страницы, если он задан, или null | | public | [hasNextCursor()](../classes/YooKassa-Request-Deals-DealsResponse.md#method_hasNextCursor) | | Проверяет, имеется ли в ответе токен следующей страницы | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -233,109 +233,89 @@ public hasNextCursor() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -384,11 +364,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md b/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md index 1d2ad383..beca93d9 100644 --- a/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md +++ b/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md @@ -85,11 +85,11 @@ | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -161,7 +161,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -174,7 +174,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -187,7 +187,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -200,7 +200,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -213,7 +213,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -252,7 +252,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -291,7 +291,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -304,7 +304,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -343,7 +343,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -356,7 +356,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -369,7 +369,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -382,7 +382,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -395,7 +395,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -408,7 +408,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -421,7 +421,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -434,7 +434,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -447,7 +447,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -460,7 +460,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -473,7 +473,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -486,7 +486,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -499,7 +499,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -512,7 +512,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -525,7 +525,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -538,7 +538,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -551,7 +551,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -564,7 +564,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -1117,109 +1117,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1845,11 +1825,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md index 34a99167..2be9d815 100644 --- a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md @@ -10,87 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 11 78 Пример использования билдера ```php -try { - $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); - $builder->setAmount(100) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setCapture(true) - ->setDescription('Оплата заказа 112233') - ->setMetadata(array( - 'cms_name' => 'yoo_api_test', - 'order_id' => '112233', - 'language' => 'ru', - 'transaction_id' => '123-456-789', - )); - - // Устанавливаем страницу для редиректа после оплаты - $builder->setConfirmation(array( - 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, - 'returnUrl' => 'https://merchant-site.ru/payment-return-page', - )); - - // Можем установить конкретный способ оплаты - $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); - - // Составляем чек - $builder->setReceiptEmail('john.doe@merchant.com'); - $builder->setReceiptPhone('71111111111'); - // Добавим товар - $builder->addReceiptItem( - 'Платок Gucci', - 3000, - 1.0, - 2, - 'full_payment', - 'commodity' - ); - // Добавим доставку - $builder->addReceiptShipping( - 'Delivery/Shipping/Доставка', - 100, - 1, - \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, - \YooKassa\Model\Receipt\PaymentSubject::SERVICE - ); - - // Можно добавить распределение денег по магазинам - $builder->setTransfers(array( - array( - 'account_id' => 123456, - 'amount' => array( - array( - 'value' => 1000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ), - array( - 'account_id' => 654321, - 'amount' => array( - array( - 'value' => 2000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ) - )); - - // Создаем объект запроса - $request = $builder->build(); - - // Можно изменить данные, если нужно - $request->setDescription($request->getDescription() . ' - merchant comment'); - - $idempotenceKey = uniqid('', true); - $response = $client->createPayment($request, $idempotenceKey); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -104,14 +26,16 @@ var_dump($response); ### Properties | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | -| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | | public | [$amount](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_amount) | | Сумма создаваемого платежа | +| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | | public | [$capture](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_capture) | | Автоматически принять поступившую оплату | | public | [$client_ip](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_client_ip) | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения | | public | [$clientIp](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_clientIp) | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения | | public | [$confirmation](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_confirmation) | | Способ подтверждения платежа | | public | [$deal](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_deal) | | Данные о сделке, в составе которой проходит платеж | | public | [$description](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_description) | | Описание транзакции | +| public | [$fraud_data](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_fraud_data) | | Информация для проверки операции на мошенничество | +| public | [$fraudData](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_fraudData) | | Информация для проверки операции на мошенничество | | public | [$merchant_customer_id](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_merchant_customer_id) | | Идентификатор покупателя в вашей системе, например электронная почта или номер телефона | | public | [$merchantCustomerId](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_merchantCustomerId) | | Идентификатор покупателя в вашей системе, например электронная почта или номер телефона | | public | [$metadata](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_metadata) | | Метаданные привязанные к платежу | @@ -121,8 +45,8 @@ var_dump($response); | public | [$paymentMethodData](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentMethodData) | | Данные используемые для создания метода оплаты | | public | [$paymentMethodId](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentMethodId) | | Идентификатор записи о сохраненных платежных данных покупателя | | public | [$paymentToken](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentToken) | | Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | -| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | | public | [$receipt](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | | public | [$recipient](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_recipient) | | Получатель платежа, если задан | | public | [$save_payment_method](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_save_payment_method) | | Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method | | public | [$savePaymentMethod](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_savePaymentMethod) | | Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method | @@ -147,6 +71,7 @@ var_dump($response); | public | [getConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | | public | [getDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getDeal) | | Возвращает данные о сделке, в составе которой проходит платеж | | public | [getDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getFraudData) | | Возвращает информацию для проверки операции на мошенничество. | | public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | | public | [getMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getMerchantCustomerId) | | Возвращает идентификатор покупателя в вашей системе | | public | [getMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | @@ -164,6 +89,7 @@ var_dump($response); | public | [hasConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasConfirmation) | | Проверяет, был ли установлен способ подтверждения платежа | | public | [hasDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasDeal) | | Проверяет, были ли установлены данные о сделке | | public | [hasDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемом платеже | +| public | [hasFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasFraudData) | | Проверяет, была ли установлена информация для проверки операции на мошенничество | | public | [hasMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasMerchantCustomerId) | | Проверяет, был ли установлен идентификатор покупателя в вашей системе | | public | [hasMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные заказа | | public | [hasPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasPaymentMethodData) | | Проверяет установлен ли объект с методом оплаты | @@ -173,11 +99,11 @@ var_dump($response); | public | [hasRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasRecipient) | | Проверяет наличие получателя платежа в запросе | | public | [hasSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasSavePaymentMethod) | | Проверяет, был ли установлен флаг сохранения платёжных данных | | public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | | public | [setAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setAirline) | | Устанавливает данные авиабилетов | | public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | @@ -186,6 +112,7 @@ var_dump($response); | public | [setConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | | public | [setDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит платеж. | | public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setFraudData) | | Устанавливает информацию для проверки операции на мошенничество. | | public | [setMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setMerchantCustomerId) | | Устанавливает идентификатор покупателя в вашей системе | | public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | | public | [setPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setPaymentMethodData) | | Устанавливает объект с информацией для создания метода оплаты | @@ -229,12 +156,11 @@ MAX_LENGTH_PAYMENT_TOKEN = 10240 --- ***Description*** -Сумма +Сумма создаваемого платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** -* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -242,11 +168,12 @@ MAX_LENGTH_PAYMENT_TOKEN = 10240 --- ***Description*** -Сумма создаваемого платежа +Сумма -**Type:** AmountInterface +**Type:** AmountInterface **Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -256,7 +183,7 @@ MAX_LENGTH_PAYMENT_TOKEN = 10240 Автоматически принять поступившую оплату -**Type:** bool +**Type:** bool **Details:** @@ -268,7 +195,7 @@ MAX_LENGTH_PAYMENT_TOKEN = 10240 IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения -**Type:** string +**Type:** string **Details:** @@ -280,7 +207,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения -**Type:** string +**Type:** string **Details:** @@ -292,7 +219,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Способ подтверждения платежа -**Type:** AbstractConfirmationAttributes +**Type:** AbstractConfirmationAttributes **Details:** @@ -304,7 +231,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** @@ -316,7 +243,31 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Описание транзакции -**Type:** string +**Type:** string + +**Details:** + + + +#### public $fraud_data : \YooKassa\Model\FraudData +--- +***Description*** + +Информация для проверки операции на мошенничество + +**Type:** FraudData + +**Details:** + + + +#### public $fraudData : \YooKassa\Model\FraudData +--- +***Description*** + +Информация для проверки операции на мошенничество + +**Type:** FraudData **Details:** @@ -328,7 +279,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** @@ -340,7 +291,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** @@ -352,7 +303,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Метаданные привязанные к платежу -**Type:** Metadata +**Type:** Metadata **Details:** @@ -364,7 +315,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Данные используемые для создания метода оплаты -**Type:** AbstractPaymentData +**Type:** AbstractPaymentData **Details:** @@ -376,7 +327,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Идентификатор записи о сохраненных платежных данных покупателя -**Type:** string +**Type:** string **Details:** @@ -388,7 +339,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget -**Type:** string +**Type:** string **Details:** @@ -400,7 +351,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Данные используемые для создания метода оплаты -**Type:** AbstractPaymentData +**Type:** AbstractPaymentData **Details:** @@ -412,7 +363,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Идентификатор записи о сохраненных платежных данных покупателя -**Type:** string +**Type:** string **Details:** @@ -424,7 +375,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget -**Type:** string +**Type:** string **Details:** @@ -436,24 +387,24 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Данные фискального чека 54-ФЗ -**Type:** ReceiptInterface +**Type:** ReceiptInterface + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) - -#### public $receipt : \YooKassa\Model\ReceiptInterface ---- -***Description*** - -Данные фискального чека 54-ФЗ - -**Type:** ReceiptInterface - -**Details:** - - #### public $recipient : \YooKassa\Model\RecipientInterface --- @@ -461,7 +412,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Получатель платежа, если задан -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** @@ -473,7 +424,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method -**Type:** bool +**Type:** bool **Details:** @@ -485,7 +436,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method -**Type:** bool +**Type:** bool **Details:** @@ -497,7 +448,7 @@ IPv4 или IPv6-адрес покупателя. Если не указан, и Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -792,6 +743,23 @@ public getDescription() : string **Returns:** string - + +#### public getFraudData() : \YooKassa\Model\FraudData|null + +```php +public getFraudData() : \YooKassa\Model\FraudData|null +``` + +**Summary** + +Возвращает информацию для проверки операции на мошенничество. + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\FraudData|null - Информация для проверки операции на мошенничество + + #### public getLastValidationError() : string @@ -1086,6 +1054,23 @@ public hasDescription() : bool **Returns:** bool - True если описание транзакции есть, false если нет + +#### public hasFraudData() : bool + +```php +public hasFraudData() : bool +``` + +**Summary** + +Проверяет, была ли установлена информация для проверки операции на мошенничество + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если информация была установлена, false если нет + + #### public hasMerchantCustomerId() : bool @@ -1240,109 +1225,89 @@ public hasTransfers() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1542,6 +1507,28 @@ public setDescription(string $value) : mixed **Returns:** mixed - + +#### public setFraudData() : mixed + +```php +public setFraudData(\YooKassa\Model\FraudData|array|null $value = null) : mixed +``` + +**Summary** + +Устанавливает информацию для проверки операции на мошенничество. + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\FraudData OR array OR null | value | Информация для проверки операции на мошенничество | + +**Returns:** mixed - + + #### public setMerchantCustomerId() : mixed @@ -1861,11 +1848,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md index 472fd71d..8bf58567 100644 --- a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md @@ -10,87 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 11 78 Пример использования билдера ```php -try { - $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); - $builder->setAmount(100) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setCapture(true) - ->setDescription('Оплата заказа 112233') - ->setMetadata(array( - 'cms_name' => 'yoo_api_test', - 'order_id' => '112233', - 'language' => 'ru', - 'transaction_id' => '123-456-789', - )); - - // Устанавливаем страницу для редиректа после оплаты - $builder->setConfirmation(array( - 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, - 'returnUrl' => 'https://merchant-site.ru/payment-return-page', - )); - - // Можем установить конкретный способ оплаты - $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); - - // Составляем чек - $builder->setReceiptEmail('john.doe@merchant.com'); - $builder->setReceiptPhone('71111111111'); - // Добавим товар - $builder->addReceiptItem( - 'Платок Gucci', - 3000, - 1.0, - 2, - 'full_payment', - 'commodity' - ); - // Добавим доставку - $builder->addReceiptShipping( - 'Delivery/Shipping/Доставка', - 100, - 1, - \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, - \YooKassa\Model\Receipt\PaymentSubject::SERVICE - ); - - // Можно добавить распределение денег по магазинам - $builder->setTransfers(array( - array( - 'account_id' => 123456, - 'amount' => array( - array( - 'value' => 1000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ), - array( - 'account_id' => 654321, - 'amount' => array( - array( - 'value' => 2000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ) - )); - - // Создаем объект запроса - $request = $builder->build(); - - // Можно изменить данные, если нужно - $request->setDescription($request->getDescription() . ' - merchant comment'); - - $idempotenceKey = uniqid('', true); - $response = $client->createPayment($request, $idempotenceKey); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -105,6 +27,7 @@ var_dump($response); | protected | [$amount](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма | | protected | [$currentObject](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | | protected | [$deal](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#property_deal) | | Объект с информацией о сделке, в составе которой проходит платеж. | +| protected | [$fraud_data](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#property_fraud_data) | | Объект с информацией о сделке, в составе которой проходит платеж. | | protected | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке | | protected | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_transfers) | | Массив платежей в пользу разных мерчантов | @@ -125,6 +48,7 @@ var_dump($response); | public | [setCurrency()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | | public | [setDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setDeal) | | Устанавливает сделку | | public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setFraudData) | | Устанавливает сделку | | public | [setGatewayId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setGatewayId) | | Устанавливает идентификатор шлюза | | public | [setMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setMerchantCustomerId) | | Устанавливает идентификатор покупателя в вашей системе | | public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | @@ -165,7 +89,7 @@ var_dump($response); Сумма -**Type:** MonetaryAmount +**Type:** MonetaryAmount **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -178,7 +102,7 @@ var_dump($response); Собираемый объект запроса -**Type:** CreatePaymentRequest +**Type:** CreatePaymentRequest **Details:** @@ -190,7 +114,19 @@ var_dump($response); Объект с информацией о сделке, в составе которой проходит платеж. -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo + +**Details:** + + + +#### protected $fraud_data : \YooKassa\Model\FraudData +--- +**Summary** + +Объект с информацией о сделке, в составе которой проходит платеж. + +**Type:** FraudData **Details:** @@ -202,7 +138,7 @@ var_dump($response); Объект с информацией о чеке -**Type:** Receipt +**Type:** Receipt **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -215,7 +151,7 @@ var_dump($response); Массив платежей в пользу разных мерчантов -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -562,6 +498,33 @@ public setDescription(string $value) : \YooKassa\Request\Payments\CreatePaymentR **Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + +#### public setFraudData() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setFraudData(\YooKassa\Model\FraudData|array|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает сделку + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\FraudData OR array OR null | value | Данные о сделке, в составе которой проходит платеж | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Информация для проверки операции на мошенничество + + #### public setGatewayId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder @@ -1084,11 +1047,11 @@ protected initCurrentObject() : \YooKassa\Request\Payments\CreatePaymentRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md index 1b1a1b8a..0e376b73 100644 --- a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md @@ -22,6 +22,7 @@ Interface CreatePaymentRequestInterface | public | [getConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | | public | [getDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getDeal) | | Возвращает данные о сделке, в составе которой проходит платеж | | public | [getDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getFraudData) | | Возвращает информацию для проверки операции на мошенничество | | public | [getMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getMerchantCustomerId) | | Возвращает идентификатор покупателя в вашей системе | | public | [getMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | | public | [getPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getPaymentMethodData) | | Возвращает данные для создания метода оплаты | @@ -37,6 +38,7 @@ Interface CreatePaymentRequestInterface | public | [hasConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasConfirmation) | | Проверяет, был ли установлен способ подтверждения платежа | | public | [hasDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasDeal) | | Проверяет, были ли установлены данные о сделке | | public | [hasDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемом платеже | +| public | [hasFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasFraudData) | | Проверяет, была ли установлена информация для проверки операции на мошенничество | | public | [hasMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasMerchantCustomerId) | | Проверяет, был ли установлен идентификатор покупателя в вашей системе | | public | [hasMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные заказа | | public | [hasPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasPaymentMethodData) | | Проверяет установлен ли объект с методом оплаты | @@ -52,6 +54,7 @@ Interface CreatePaymentRequestInterface | public | [setConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | | public | [setDeal()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит платеж. | | public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setFraudData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setFraudData) | | Устанавливает информацию для проверки операции на мошенничество | | public | [setMerchantCustomerId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setMerchantCustomerId) | | Устанавливает идентификатор покупателя в вашей системе | | public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | | public | [setPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setPaymentMethodData) | | Устанавливает объект с информацией для создания метода оплаты | @@ -88,6 +91,8 @@ Interface CreatePaymentRequestInterface | property-read | | Метаданные привязанные к платежу | | property-read | | Метаданные привязанные к платежу | | property-read | | Данные о сделке, в составе которой проходит платеж | +| property-read | | Информация для проверки операции на мошенничество | +| property-read | | Информация для проверки операции на мошенничество | | property-read | | Идентификатор покупателя в вашей системе, например электронная почта или номер телефона | | property-read | | Идентификатор покупателя в вашей системе, например электронная почта или номер телефона | @@ -803,7 +808,7 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] #### public setTransfers() : mixed ```php -public setTransfers(mixed $value) : mixed +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed ``` **Summary** @@ -821,7 +826,7 @@ public setTransfers(mixed $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| mixed | value | | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | Данные о распределении денег | **Returns:** mixed - @@ -882,6 +887,62 @@ public setDeal(\YooKassa\Model\Deal\PaymentDealInfo|array|null $value) : mixed **Returns:** mixed - + +#### public getFraudData() : \YooKassa\Model\FraudData + +```php +public getFraudData() : \YooKassa\Model\FraudData +``` + +**Summary** + +Возвращает информацию для проверки операции на мошенничество + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\FraudData - Информация для проверки операции на мошенничество + + + +#### public hasFraudData() : bool + +```php +public hasFraudData() : bool +``` + +**Summary** + +Проверяет, была ли установлена информация для проверки операции на мошенничество + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если информация была установлена, false если нет + + + +#### public setFraudData() : mixed + +```php +public setFraudData(\YooKassa\Model\FraudData|array|null $value) : mixed +``` + +**Summary** + +Устанавливает информацию для проверки операции на мошенничество + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\FraudData OR array OR null | value | Информация для проверки операции на мошенничество | + +**Returns:** mixed - + + #### public getMerchantCustomerId() : string @@ -950,11 +1011,11 @@ public setMerchantCustomerId(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md index 6186137b..0eae4f4f 100644 --- a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Payments\CreatePaymentRequestInterface $reque ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md index d50cdc56..b033105d 100644 --- a/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md @@ -85,11 +85,11 @@ | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -160,7 +160,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -173,7 +173,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -186,7 +186,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -199,7 +199,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -212,7 +212,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -251,7 +251,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -290,7 +290,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -303,7 +303,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -342,7 +342,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -355,7 +355,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -368,7 +368,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -381,7 +381,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -394,7 +394,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -407,7 +407,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -420,7 +420,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -433,7 +433,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -446,7 +446,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -459,7 +459,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -472,7 +472,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -485,7 +485,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -498,7 +498,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -511,7 +511,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -524,7 +524,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -537,7 +537,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -550,7 +550,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -563,7 +563,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -1111,109 +1111,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1839,11 +1819,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md b/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md index aec19f1e..f0e87154 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md @@ -85,11 +85,11 @@ | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -160,7 +160,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -173,7 +173,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -186,7 +186,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -199,7 +199,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -212,7 +212,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -251,7 +251,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -290,7 +290,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -303,7 +303,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -342,7 +342,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -355,7 +355,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -368,7 +368,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -381,7 +381,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -394,7 +394,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -407,7 +407,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -420,7 +420,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -433,7 +433,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -446,7 +446,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -459,7 +459,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -472,7 +472,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -485,7 +485,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -498,7 +498,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -511,7 +511,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -524,7 +524,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -537,7 +537,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -550,7 +550,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -563,7 +563,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -1111,109 +1111,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1839,11 +1819,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md index 1dfd8e23..87aec318 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md @@ -44,11 +44,11 @@ | public | [hasDeal()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_hasDeal) | | Проверяет, были ли установлены данные о сделке | | public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | | public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | | public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | | public | [setDeal()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит платеж. | @@ -62,7 +62,7 @@ --- ### Details * File: [lib/Request/Payments/Payment/CreateCaptureRequest.php](../../lib/Request/Payments/Payment/CreateCaptureRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -80,7 +80,7 @@ Подтверждаемая сумма оплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -92,7 +92,7 @@ Сумма -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -105,7 +105,7 @@ Данные о сделке, в составе которой проходит платеж -**Type:** CaptureDealData +**Type:** CaptureDealData **Details:** @@ -117,7 +117,7 @@ Данные фискального чека 54-ФЗ -**Type:** ReceiptInterface +**Type:** ReceiptInterface **Details:** @@ -129,7 +129,7 @@ Данные фискального чека 54-ФЗ -**Type:** ReceiptInterface +**Type:** ReceiptInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -142,7 +142,7 @@ Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) @@ -477,109 +477,89 @@ public hasTransfers() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -782,11 +762,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md index a1ee153c..3c0f4e84 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md @@ -45,7 +45,7 @@ --- ### Details * File: [lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php](../../lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) * [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -60,7 +60,7 @@ Сумма -**Type:** MonetaryAmount +**Type:** MonetaryAmount **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -73,7 +73,7 @@ Собираемый объект запроса -**Type:** CreateCaptureRequest +**Type:** CreateCaptureRequest **Details:** @@ -85,7 +85,7 @@ Объект с информацией о сделке, в составе которой проходит подтверждение платежа. -**Type:** CaptureDealData +**Type:** CaptureDealData **Details:** @@ -97,7 +97,7 @@ Объект с информацией о чеке -**Type:** Receipt +**Type:** Receipt **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -110,7 +110,7 @@ Массив платежей в пользу разных мерчантов -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -501,11 +501,11 @@ protected initCurrentObject() : \YooKassa\Request\Payments\Payment\CreateCapture ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md index 5d09bd70..b5351e1d 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md @@ -291,11 +291,11 @@ public setDeal(\YooKassa\Model\Deal\PaymentDealInfo|array|null $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md index 5e610e45..5c2acd21 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterfac ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md index 80e42b5d..600f9df2 100644 --- a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md @@ -85,11 +85,11 @@ | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -160,7 +160,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -173,7 +173,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -186,7 +186,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -199,7 +199,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -212,7 +212,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -251,7 +251,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -290,7 +290,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -303,7 +303,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -342,7 +342,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -355,7 +355,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -368,7 +368,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -381,7 +381,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -394,7 +394,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -407,7 +407,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -420,7 +420,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -433,7 +433,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -446,7 +446,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -459,7 +459,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -472,7 +472,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -485,7 +485,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -498,7 +498,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -511,7 +511,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -524,7 +524,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -537,7 +537,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -550,7 +550,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -563,7 +563,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -1111,109 +1111,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1839,11 +1819,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentResponse.md b/docs/classes/YooKassa-Request-Payments-PaymentResponse.md index c3fe7c41..d4d70572 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentResponse.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentResponse.md @@ -85,11 +85,11 @@ | public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | | public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | | public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | | public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | @@ -160,7 +160,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма заказа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -173,7 +173,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -186,7 +186,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные об авторизации платежа -**Type:** AuthorizationDetailsInterface +**Type:** AuthorizationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -199,7 +199,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -212,7 +212,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Комментарий к отмене платежа -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -251,7 +251,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ подтверждения платежа -**Type:** AbstractConfirmation +**Type:** AbstractConfirmation **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -290,7 +290,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о сделке, в составе которой проходит платеж -**Type:** PaymentDealInfo +**Type:** PaymentDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -303,7 +303,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -342,7 +342,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -355,7 +355,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -368,7 +368,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма платежа, которую получит магазин -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -381,7 +381,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -394,7 +394,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Идентификатор покупателя в вашей системе, например электронная почта или номер телефона -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -407,7 +407,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Метаданные платежа указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -420,7 +420,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак оплаты заказа -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -433,7 +433,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -446,7 +446,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Способ проведения платежа -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -459,7 +459,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -472,7 +472,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Состояние регистрации фискального чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -485,7 +485,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Получатель платежа -**Type:** RecipientInterface +**Type:** RecipientInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -498,7 +498,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Возможность провести возврат по API -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -511,7 +511,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -524,7 +524,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Сумма возвращенных средств платежа -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -537,7 +537,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Текущее состояние платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -550,7 +550,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -563,7 +563,7 @@ MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200 Данные о распределении платежа между магазинами -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) @@ -1111,109 +1111,89 @@ public getTransfers() : \YooKassa\Model\TransferInterface[] -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1839,11 +1819,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md index 8bb0fdb9..85412434 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md @@ -68,11 +68,11 @@ | public | [hasLimit()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasLimit) | | Проверяет, было ли установлено ограничение количества объектов платежа | | public | [hasPaymentMethod()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasPaymentMethod) | | Проверяет, был ли установлен платежный метод выбираемых платежей | | public | [hasStatus()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasStatus) | | Проверяет, был ли установлен статус выбираемых платежей | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCapturedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtGt) | | Устанавливает дату подтверждения от которой выбираются платежи | | public | [setCapturedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtGte) | | Устанавливает дату подтверждения от которой выбираются платежи | | public | [setCapturedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtLt) | | Устанавливает дату подтверждения до которой выбираются платежи | @@ -93,7 +93,7 @@ --- ### Details * File: [lib/Request/Payments/PaymentsRequest.php](../../lib/Request/Payments/PaymentsRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -122,7 +122,7 @@ MAX_LIMIT_VALUE = 100 Время подтверждения, от (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -134,7 +134,7 @@ MAX_LIMIT_VALUE = 100 Время подтверждения, от (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -146,7 +146,7 @@ MAX_LIMIT_VALUE = 100 Время подтверждения, до (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -158,7 +158,7 @@ MAX_LIMIT_VALUE = 100 Время подтверждения, до (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -170,7 +170,7 @@ MAX_LIMIT_VALUE = 100 Время создания, от (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -182,7 +182,7 @@ MAX_LIMIT_VALUE = 100 Время создания, от (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -194,7 +194,7 @@ MAX_LIMIT_VALUE = 100 Время создания, до (не включая) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -206,7 +206,7 @@ MAX_LIMIT_VALUE = 100 Время создания, до (включительно) -**Type:** DateTime|null +**Type:** DateTime|null **Details:** @@ -218,7 +218,7 @@ MAX_LIMIT_VALUE = 100 Страница выдачи результатов, которую необходимо отобразить -**Type:** string|null +**Type:** string|null **Details:** @@ -230,7 +230,7 @@ MAX_LIMIT_VALUE = 100 Ограничение количества объектов платежа, отображаемых на одной странице выдачи -**Type:** int|null +**Type:** int|null **Details:** @@ -242,7 +242,7 @@ MAX_LIMIT_VALUE = 100 Платежный метод -**Type:** string|null +**Type:** string|null **Details:** @@ -254,7 +254,7 @@ MAX_LIMIT_VALUE = 100 Статус платежа -**Type:** string|null +**Type:** string|null **Details:** @@ -855,109 +855,89 @@ public hasStatus() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1379,11 +1359,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md index 0028ba73..1207fcd1 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md @@ -56,7 +56,7 @@ Инстанс собираемого запроса -**Type:** PaymentsRequest +**Type:** PaymentsRequest Собираемый объект запроса списка платежей магазина **Details:** @@ -493,11 +493,11 @@ protected initCurrentObject() : \YooKassa\Request\Payments\PaymentsRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md index 2edaeb90..100ed3e3 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md @@ -760,11 +760,11 @@ public setPaymentMethod(string $value) : void ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md index 3072973d..7216ab26 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Payments\PaymentsRequestInterface $request) : ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md b/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md index 92707339..96fdd01f 100644 --- a/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md +++ b/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md @@ -25,11 +25,11 @@ | public | [getItems()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_getItems) | | Возвращает список платежей | | public | [getNextCursor()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_getNextCursor) | | Возвращает токен следующей страницы, если он задан, или null | | public | [hasNextCursor()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_hasNextCursor) | | Проверяет, имеется ли в ответе токен следующей страницы | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -233,109 +233,89 @@ public hasNextCursor() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -384,11 +364,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-AbstractPayoutResponse.md b/docs/classes/YooKassa-Request-Payouts-AbstractPayoutResponse.md index 149c5e02..a04c6de9 100644 --- a/docs/classes/YooKassa-Request-Payouts-AbstractPayoutResponse.md +++ b/docs/classes/YooKassa-Request-Payouts-AbstractPayoutResponse.md @@ -29,6 +29,9 @@ | public | [$metadata](../classes/YooKassa-Model-Payout.md#property_metadata) | | Метаданные выплаты указанные мерчантом | | public | [$payout_destination](../classes/YooKassa-Model-Payout.md#property_payout_destination) | | Способ проведения выплаты | | public | [$payoutDestination](../classes/YooKassa-Model-Payout.md#property_payoutDestination) | | Способ проведения выплаты | +| public | [$receipt](../classes/YooKassa-Model-Payout.md#property_receipt) | | Данные чека, зарегистрированного в ФНС | +| public | [$self_employed](../classes/YooKassa-Model-Payout.md#property_self_employed) | | Данные самозанятого, который получит выплату | +| public | [$selfEmployed](../classes/YooKassa-Model-Payout.md#property_selfEmployed) | | Данные самозанятого, который получит выплату | | public | [$status](../classes/YooKassa-Model-Payout.md#property_status) | | Текущее состояние выплаты | | public | [$test](../classes/YooKassa-Model-Payout.md#property_test) | | Признак тестовой операции | @@ -50,13 +53,15 @@ | public | [getId()](../classes/YooKassa-Model-Payout.md#method_getId) | | Возвращает идентификатор выплаты | | public | [getMetadata()](../classes/YooKassa-Model-Payout.md#method_getMetadata) | | Возвращает метаданные выплаты установленные мерчантом | | public | [getPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_getPayoutDestination) | | Возвращает используемый способ проведения выплаты | +| public | [getReceipt()](../classes/YooKassa-Model-Payout.md#method_getReceipt) | | Возвращает данные чека, зарегистрированного в ФНС. | +| public | [getSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [getStatus()](../classes/YooKassa-Model-Payout.md#method_getStatus) | | Возвращает состояние выплаты | | public | [getTest()](../classes/YooKassa-Model-Payout.md#method_getTest) | | Возвращает признак тестовой операции | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payout.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payout.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | | public | [setCreatedAt()](../classes/YooKassa-Model-Payout.md#method_setCreatedAt) | | Устанавливает время создания заказа | @@ -65,6 +70,8 @@ | public | [setId()](../classes/YooKassa-Model-Payout.md#method_setId) | | Устанавливает идентификатор выплаты | | public | [setMetadata()](../classes/YooKassa-Model-Payout.md#method_setMetadata) | | Устанавливает метаданные выплаты | | public | [setPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_setPayoutDestination) | | Устанавливает используемый способ проведения выплаты | +| public | [setReceipt()](../classes/YooKassa-Model-Payout.md#method_setReceipt) | | Устанавливает данные чека, зарегистрированного в ФНС. | +| public | [setSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | public | [setStatus()](../classes/YooKassa-Model-Payout.md#method_setStatus) | | Устанавливает статус выплаты | | public | [setTest()](../classes/YooKassa-Model-Payout.md#method_setTest) | | Устанавливает признак тестовой операции | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -78,8 +85,6 @@ * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) * \YooKassa\Request\Payouts\AbstractPayoutResponse -* Implements: - * [\YooKassa\Model\PayoutInterface](../classes/YooKassa-Model-PayoutInterface.md) --- ## Constants @@ -104,7 +109,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сумма выплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -117,7 +122,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -130,7 +135,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -169,7 +174,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сделка, в рамках которой нужно провести выплату -**Type:** PayoutDealInfo +**Type:** PayoutDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -182,7 +187,7 @@ MAX_LENGTH_DESCRIPTION = 128 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -195,7 +200,7 @@ MAX_LENGTH_DESCRIPTION = 128 Идентификатор выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -208,7 +213,7 @@ MAX_LENGTH_DESCRIPTION = 128 Метаданные выплаты указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -221,7 +226,7 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -234,7 +239,46 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $receipt : \YooKassa\Model\Payout\IncomeReceipt +--- +***Description*** + +Данные чека, зарегистрированного в ФНС + +**Type:** IncomeReceipt + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $self_employed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $selfEmployed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -247,7 +291,7 @@ MAX_LENGTH_DESCRIPTION = 128 Текущее состояние выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -260,7 +304,7 @@ MAX_LENGTH_DESCRIPTION = 128 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -542,6 +586,40 @@ public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMet **Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения выплаты + +#### public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null + +```php +public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null +``` + +**Summary** + +Возвращает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\IncomeReceipt|null - Данные чека, зарегистрированного в ФНС + + + +#### public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null + +```php +public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\PayoutSelfEmployed|null - Данные самозанятого, который получит выплату + + #### public getStatus() : string @@ -577,116 +655,96 @@ public getTest() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - #### public setAmount() : mixed ```php -public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : mixed ``` **Summary** @@ -699,7 +757,7 @@ public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма выплаты | **Returns:** mixed - @@ -759,7 +817,7 @@ public setCreatedAt(\DateTime|string|int $value) : mixed #### public setDeal() : mixed ```php -public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed +public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed ``` **Summary** @@ -772,7 +830,7 @@ public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Deal\PayoutDealInfo OR array | value | Сделка, в рамках которой нужно провести выплату | +| \YooKassa\Model\Deal\PayoutDealInfo OR array OR null | value | Сделка, в рамках которой нужно провести выплату | **Returns:** mixed - @@ -837,7 +895,7 @@ public setId(string $value) : mixed #### public setMetadata() : mixed ```php -public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed +public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ``` **Summary** @@ -850,7 +908,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Metadata OR array | value | Метаданные выплаты указанные мерчантом | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные выплаты указанные мерчантом | **Returns:** mixed - @@ -859,7 +917,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed #### public setPayoutDestination() : mixed ```php -public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array $value) : mixed +public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed ``` **Summary** @@ -872,11 +930,55 @@ public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|arr ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Payout\AbstractPayoutDestination OR array | value | Способ проведения выплаты | +| \YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null | value | Способ проведения выплаты | **Returns:** mixed - + +#### public setReceipt() : $this + +```php +public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\IncomeReceipt OR array OR null | value | Данные чека, зарегистрированного в ФНС | + +**Returns:** $this - + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\PayoutSelfEmployed OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + #### public setStatus() : mixed @@ -973,11 +1075,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.md b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.md index 79adc5ce..5c033403 100644 --- a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.md +++ b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.md @@ -20,10 +20,18 @@ | public | [$deal](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_deal) | | Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку | | public | [$description](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_description) | | Описание транзакции (не более 128 символов). Например: «Выплата по договору N» | | public | [$metadata](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_metadata) | | Метаданные привязанные к выплате | +| public | [$payment_method_id](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_payment_method_id) | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | +| public | [$paymentMethodId](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_paymentMethodId) | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | | public | [$payout_destination_data](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_payout_destination_data) | | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | | public | [$payout_token](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_payout_token) | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | | public | [$payoutDestinationData](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_payoutDestinationData) | | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | | public | [$payoutToken](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_payoutToken) | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | +| public | [$personal_data](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_personal_data) | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | +| public | [$personalData](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_personalData) | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | +| public | [$receipt_data](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_receipt_data) | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| public | [$receiptData](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_receiptData) | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| public | [$self_employed](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_self_employed) | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| public | [$selfEmployed](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#property_selfEmployed) | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | --- ### Methods @@ -42,25 +50,37 @@ | public | [getDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getDescription) | | Возвращает описание транзакции | | public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | | public | [getMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | +| public | [getPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getPaymentMethodId) | | Возвращает идентификатор сохраненного способа оплаты. | | public | [getPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getPayoutDestinationData) | | Возвращает данные для создания метода оплаты | -| public | [getPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getPayoutToken) | | Проверяет наличие токенизированных данных для выплаты | +| public | [getPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getPayoutToken) | | Возвращает токенизированные данные для выплаты | +| public | [getPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getPersonalData) | | Возвращает персональные данные получателя выплаты. | +| public | [getReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getReceiptData) | | Возвращает данные для формирования чека в сервисе Мой налог. | +| public | [getSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [hasAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма выплаты | | public | [hasDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasDeal) | | Проверяет наличие сделки в создаваемой выплате | | public | [hasDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемом платеже | | public | [hasMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные выплаты | +| public | [hasPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasPaymentMethodId) | | Проверяет наличие идентификатора сохраненного способа оплаты | | public | [hasPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasPayoutDestinationData) | | Проверяет установлен ли объект с методом оплаты | -| public | [hasPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasPayoutToken) | | Проверяет наличие одноразового токена для проведения оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [hasPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasPayoutToken) | | Проверяет наличие токенизированных данных для выплаты | +| public | [hasPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasPersonalData) | | Проверяет наличие персональных данных в создаваемой выплате | +| public | [hasReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasReceiptData) | | Проверяет наличие данных для формирования чека в сервисе Мой налог. | +| public | [hasSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_hasSelfEmployed) | | Проверяет наличие данных самозанятого в создаваемой выплате | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setDeal) | | Устанавливает сделку, в рамках которой нужно провести выплату | | public | [setDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setDescription) | | Устанавливает описание транзакции | | public | [setMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setMetadata) | | Устанавливает метаданные, привязанные к выплате | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setPaymentMethodId) | | Устанавливает идентификатор сохраненного способа оплаты. | | public | [setPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setPayoutDestinationData) | | Устанавливает объект с информацией для создания метода оплаты | | public | [setPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setPayoutToken) | | Устанавливает токенизированные данные для выплаты | +| public | [setPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setPersonalData) | | Устанавливает персональные данные получателя выплаты. | +| public | [setReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setReceiptData) | | Устанавливает данные для формирования чека в сервисе Мой налог. | +| public | [setSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | public | [validate()](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md#method_validate) | | Проверяет на валидность текущий объект | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -92,7 +112,7 @@ Сумма создаваемой выплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -104,7 +124,7 @@ Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку -**Type:** PayoutDealInfo +**Type:** PayoutDealInfo **Details:** @@ -116,7 +136,7 @@ Описание транзакции (не более 128 символов). Например: «Выплата по договору N» -**Type:** string +**Type:** string **Details:** @@ -128,7 +148,31 @@ Метаданные привязанные к выплате -**Type:** Metadata +**Type:** Metadata + +**Details:** + + + +#### public $payment_method_id : string +--- +***Description*** + +Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты + +**Type:** string + +**Details:** + + + +#### public $paymentMethodId : string +--- +***Description*** + +Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты + +**Type:** string **Details:** @@ -140,7 +184,7 @@ Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. -**Type:** AbstractPayoutDestination +**Type:** AbstractPayoutDestination **Details:** @@ -152,7 +196,7 @@ Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data -**Type:** string +**Type:** string **Details:** @@ -164,7 +208,7 @@ Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. -**Type:** AbstractPayoutDestination +**Type:** AbstractPayoutDestination **Details:** @@ -176,7 +220,79 @@ Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data -**Type:** string +**Type:** string + +**Details:** + + + +#### public $personal_data : \YooKassa\Request\Payouts\PayoutPersonalData +--- +***Description*** + +Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). + +**Type:** PayoutPersonalData + +**Details:** + + + +#### public $personalData : \YooKassa\Request\Payouts\PayoutPersonalData +--- +***Description*** + +Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). + +**Type:** PayoutPersonalData + +**Details:** + + + +#### public $receipt_data : \YooKassa\Request\Payouts\IncomeReceiptData +--- +***Description*** + +Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +**Type:** IncomeReceiptData + +**Details:** + + + +#### public $receiptData : \YooKassa\Request\Payouts\IncomeReceiptData +--- +***Description*** + +Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +**Type:** IncomeReceiptData + +**Details:** + + + +#### public $self_employed : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo +--- +***Description*** + +Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +**Type:** PayoutSelfEmployedInfo + +**Details:** + + + +#### public $selfEmployed : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo +--- +***Description*** + +Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +**Type:** PayoutSelfEmployedInfo **Details:** @@ -436,6 +552,23 @@ public getMetadata() : \YooKassa\Model\Metadata **Returns:** \YooKassa\Model\Metadata - Метаданные, привязанные к выплате + +#### public getPaymentMethodId() : string|null + +```php +public getPaymentMethodId() : string|null +``` + +**Summary** + +Возвращает идентификатор сохраненного способа оплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** string|null - Идентификатор сохраненного способа оплаты + + #### public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination @@ -454,20 +587,71 @@ public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestina -#### public getPayoutToken() : bool +#### public getPayoutToken() : string ```php -public getPayoutToken() : bool +public getPayoutToken() : string ``` **Summary** -Проверяет наличие токенизированных данных для выплаты +Возвращает токенизированные данные для выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) -**Returns:** bool - True если токен установлен, false если нет +**Returns:** string - Токенизированные данные для выплаты + + + +#### public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null + +```php +public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null +``` + +**Summary** + +Возвращает персональные данные получателя выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** \YooKassa\Request\Payouts\PayoutPersonalData[]|null - Персональные данные получателя выплаты + + + +#### public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null + +```php +public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null +``` + +**Summary** + +Возвращает данные для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** \YooKassa\Request\Payouts\IncomeReceiptData|null - Данные для формирования чека в сервисе Мой налог + + + +#### public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null + +```php +public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null - Данные самозанятого, который получит выплату @@ -538,6 +722,23 @@ public hasMetadata() : bool **Returns:** bool - True если метаданные были установлены, false если нет + +#### public hasPaymentMethodId() : bool + +```php +public hasPaymentMethodId() : bool +``` + +**Summary** + +Проверяет наличие идентификатора сохраненного способа оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** bool - True если идентификатора установлен, false если нет + + #### public hasPayoutDestinationData() : bool @@ -564,7 +765,7 @@ public hasPayoutToken() : bool **Summary** -Проверяет наличие одноразового токена для проведения оплаты +Проверяет наличие токенизированных данных для выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) @@ -572,117 +773,148 @@ public hasPayoutToken() : bool **Returns:** bool - True если токен установлен, false если нет - -#### public jsonSerialize() : array + +#### public hasPersonalData() : bool ```php -public jsonSerialize() : array +public hasPersonalData() : bool ``` **Summary** -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Проверяет наличие персональных данных в создаваемой выплате + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** bool - True если персональные данные есть, false если нет + + + +#### public hasReceiptData() : bool + +```php +public hasReceiptData() : bool +``` + +**Summary** + +Проверяет наличие данных для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** bool - True если данные для формирования чека есть, false если нет + + + +#### public hasSelfEmployed() : bool + +```php +public hasSelfEmployed() : bool +``` + +**Summary** + +Проверяет наличие данных самозанятого в создаваемой выплате + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +**Returns:** bool - True если данные самозанятого есть, false если нет + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - #### public setAmount() : mixed ```php -public setAmount(mixed $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array|string|numeric-string|int|float|null $value) : mixed ``` **Summary** @@ -695,7 +927,7 @@ public setAmount(mixed $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| mixed | value | | +| \YooKassa\Model\AmountInterface OR array OR string OR numeric-string OR int OR float OR null | value | Сумма выплаты | ##### Throws: | Type | Description | @@ -782,6 +1014,28 @@ public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed **Returns:** mixed - + +#### public setPaymentMethodId() : $this + +```php +public setPaymentMethodId(string|null $value = null) : $this +``` + +**Summary** + +Устанавливает идентификатор сохраненного способа оплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор сохраненного способа оплаты | + +**Returns:** $this - + + #### public setPayoutDestinationData() : mixed @@ -836,6 +1090,72 @@ public setPayoutToken(string $value) : mixed **Returns:** mixed - + +#### public setPersonalData() : $this + +```php +public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает персональные данные получателя выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null | value | Персональные данные получателя выплаты | + +**Returns:** $this - + + + +#### public setReceiptData() : $this + +```php +public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\IncomeReceiptData OR array OR null | value | Данные для формирования чека в сервисе Мой налог | + +**Returns:** $this - + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequest](../classes/YooKassa-Request-Payouts-CreatePayoutRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutSelfEmployedInfo OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + #### public toArray() : array @@ -921,11 +1241,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md index a672ebce..ee6fb8ed 100644 --- a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md @@ -10,87 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 11 78 Пример использования билдера ```php -try { - $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); - $builder->setAmount(100) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setCapture(true) - ->setDescription('Оплата заказа 112233') - ->setMetadata(array( - 'cms_name' => 'yoo_api_test', - 'order_id' => '112233', - 'language' => 'ru', - 'transaction_id' => '123-456-789', - )); - - // Устанавливаем страницу для редиректа после оплаты - $builder->setConfirmation(array( - 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, - 'returnUrl' => 'https://merchant-site.ru/payment-return-page', - )); - - // Можем установить конкретный способ оплаты - $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); - - // Составляем чек - $builder->setReceiptEmail('john.doe@merchant.com'); - $builder->setReceiptPhone('71111111111'); - // Добавим товар - $builder->addReceiptItem( - 'Платок Gucci', - 3000, - 1.0, - 2, - 'full_payment', - 'commodity' - ); - // Добавим доставку - $builder->addReceiptShipping( - 'Delivery/Shipping/Доставка', - 100, - 1, - \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, - \YooKassa\Model\Receipt\PaymentSubject::SERVICE - ); - - // Можно добавить распределение денег по магазинам - $builder->setTransfers(array( - array( - 'account_id' => 123456, - 'amount' => array( - array( - 'value' => 1000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ), - array( - 'account_id' => 654321, - 'amount' => array( - array( - 'value' => 2000, - 'currency' => \YooKassa\Model\CurrencyCode::RUB - ) - ), - ) - )); - - // Создаем объект запроса - $request = $builder->build(); - - // Можно изменить данные, если нужно - $request->setDescription($request->getDescription() . ' - merchant comment'); - - $idempotenceKey = uniqid('', true); - $response = $client->createPayment($request, $idempotenceKey); -} catch (\Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -115,8 +37,12 @@ var_dump($response); | public | [setDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setDescription) | | Устанавливает описание транзакции | | public | [setMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | | public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setPaymentMethodId) | | Устанавливает идентификатор сохраненного способа оплаты. | | public | [setPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setPayoutDestinationData) | | Устанавливает объект с информацией для создания метода оплаты | | public | [setPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setPayoutToken) | | Устанавливает одноразовый токен для проведения выплаты | +| public | [setPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setPersonalData) | | Устанавливает персональные данные получателя выплаты. | +| public | [setReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setReceiptData) | | Устанавливает данные для формирования чека в сервисе Мой налог. | +| public | [setSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | protected | [initCurrentObject()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером | --- @@ -136,7 +62,7 @@ var_dump($response); Собираемый объект запроса -**Type:** CreatePayoutRequest +**Type:** CreatePayoutRequest **Details:** @@ -320,6 +246,33 @@ public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractReques **Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + +#### public setPaymentMethodId() : mixed + +```php +public setPaymentMethodId(string|null $value) : mixed +``` + +**Summary** + +Устанавливает идентификатор сохраненного способа оплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestBuilder](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор сохраненного способа оплаты | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** mixed - + + #### public setPayoutDestinationData() : mixed @@ -374,6 +327,87 @@ public setPayoutToken(string $value) : \YooKassa\Request\Payouts\CreatePayoutReq **Returns:** \YooKassa\Request\Payouts\CreatePayoutRequestBuilder - Инстанс текущего билдера + +#### public setPersonalData() : mixed + +```php +public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value) : mixed +``` + +**Summary** + +Устанавливает персональные данные получателя выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestBuilder](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null | value | Персональные данные получателя выплаты | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** mixed - + + + +#### public setReceiptData() : mixed + +```php +public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value) : mixed +``` + +**Summary** + +Устанавливает данные для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestBuilder](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\IncomeReceiptData OR array OR null | value | Данные для формирования чека в сервисе Мой налог | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** mixed - + + + +#### public setSelfEmployed() : mixed + +```php +public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value) : mixed +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestBuilder](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutSelfEmployedInfo OR array OR null | value | Данные самозанятого, который получит выплату | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** mixed - + + #### protected initCurrentObject() : \YooKassa\Request\Payouts\CreatePayoutRequest @@ -402,11 +436,11 @@ protected initCurrentObject() : \YooKassa\Request\Payouts\CreatePayoutRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md index 160a406b..012e25b4 100644 --- a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md +++ b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md @@ -19,20 +19,32 @@ Interface CreatePayoutRequestInterface | public | [getDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getDeal) | | Возвращает сделку, в рамках которой нужно провести выплату | | public | [getDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getDescription) | | Возвращает описание транзакции | | public | [getMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | +| public | [getPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPaymentMethodId) | | Возвращает идентификатор сохраненного способа оплаты. | | public | [getPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPayoutDestinationData) | | Возвращает данные платежного средства, на которое нужно сделать выплату | | public | [getPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPayoutToken) | | Возвращает токенизированные данные для выплаты | +| public | [getPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPersonalData) | | Возвращает персональные данные получателя выплаты. | +| public | [getReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getReceiptData) | | Возвращает данные для формирования чека в сервисе Мой налог. | +| public | [getSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [hasAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasAmount) | | Проверяет наличие суммы в создаваемой выплате | | public | [hasDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasDeal) | | Проверяет установлена ли сделка, в рамках которой нужно провести выплату | | public | [hasDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемой выплате | | public | [hasMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные заказа | +| public | [hasPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPaymentMethodId) | | Проверяет наличие идентификатора сохраненного способа оплаты | | public | [hasPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPayoutDestinationData) | | Проверяет наличие данных платежного средства, на которое нужно сделать выплату | | public | [hasPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPayoutToken) | | Проверяет наличие токенизированных данных для выплаты | +| public | [hasPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPersonalData) | | Проверяет наличие персональных данных в создаваемой выплате | +| public | [hasReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasReceiptData) | | Проверяет наличие данных для формирования чека в сервисе Мой налог. | +| public | [hasSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasSelfEmployed) | | Проверяет наличие данных самозанятого в создаваемой выплате | | public | [setAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setDeal) | | Устанавливает сделку, в рамках которой нужно провести выплату | | public | [setDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setDescription) | | Устанавливает описание транзакции | | public | [setMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setMetadata) | | Устанавливает метаданные, привязанные к выплате | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPaymentMethodId) | | Устанавливает идентификатор сохраненного способа оплаты. | | public | [setPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPayoutDestinationData) | | Устанавливает данные платежного средства, на которое нужно сделать выплату | | public | [setPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPayoutToken) | | Устанавливает токенизированные данные для выплаты | +| public | [setPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPersonalData) | | Устанавливает персональные данные получателя выплаты. | +| public | [setReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setReceiptData) | | Устанавливает данные для формирования чека в сервисе Мой налог. | +| public | [setSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | --- ### Details @@ -48,8 +60,16 @@ Interface CreatePayoutRequestInterface | property | | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | | property | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | | property | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | +| property | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | +| property | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | | property | | Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку | | property | | Описание транзакции (не более 128 символов). Например: «Выплата по договору N» | +| property | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| property | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| property | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| property | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | +| property | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | +| property | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | | property | | Метаданные привязанные к выплате | --- @@ -92,7 +112,7 @@ public hasAmount() : bool #### public setAmount() : mixed ```php -public setAmount(mixed $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ``` **Summary** @@ -105,7 +125,7 @@ public setAmount(mixed $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| mixed | value | | +| \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | **Returns:** mixed - @@ -222,6 +242,62 @@ public setPayoutToken(string $value) : mixed **Returns:** mixed - + +#### public getPaymentMethodId() : string|null + +```php +public getPaymentMethodId() : string|null +``` + +**Summary** + +Возвращает идентификатор сохраненного способа оплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** string|null - Идентификатор сохраненного способа оплаты + + + +#### public hasPaymentMethodId() : bool + +```php +public hasPaymentMethodId() : bool +``` + +**Summary** + +Проверяет наличие идентификатора сохраненного способа оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** bool - True если идентификатора установлен, false если нет + + + +#### public setPaymentMethodId() : $this + +```php +public setPaymentMethodId(string|null $value = null) : $this +``` + +**Summary** + +Устанавливает идентификатор сохраненного способа оплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор сохраненного способа оплаты | + +**Returns:** $this - + + #### public getDescription() : string @@ -334,6 +410,178 @@ public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed **Returns:** mixed - + +#### public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null + +```php +public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null - Данные самозанятого, который получит выплату + + + +#### public hasSelfEmployed() : bool + +```php +public hasSelfEmployed() : bool +``` + +**Summary** + +Проверяет наличие данных самозанятого в создаваемой выплате + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** bool - True если данные самозанятого есть, false если нет + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutSelfEmployedInfo OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + + +#### public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null + +```php +public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null +``` + +**Summary** + +Возвращает данные для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** \YooKassa\Request\Payouts\IncomeReceiptData|null - Данные для формирования чека в сервисе Мой налог + + + +#### public hasReceiptData() : bool + +```php +public hasReceiptData() : bool +``` + +**Summary** + +Проверяет наличие данных для формирования чека в сервисе Мой налог. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** bool - True если данные для формирования чека есть, false если нет + + + +#### public setReceiptData() : $this + +```php +public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные для формирования чека в сервисе Мой налог. + +**Description** + +. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\IncomeReceiptData OR array OR null | value | Данные для формирования чека в сервисе Мой налог. | + +**Returns:** $this - + + + +#### public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null + +```php +public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null +``` + +**Summary** + +Возвращает персональные данные получателя выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** \YooKassa\Request\Payouts\PayoutPersonalData[]|null - Персональные данные получателя выплаты + + + +#### public hasPersonalData() : bool + +```php +public hasPersonalData() : bool +``` + +**Summary** + +Проверяет наличие персональных данных в создаваемой выплате + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +**Returns:** bool - True если персональные данные есть, false если нет + + + +#### public setPersonalData() : $this + +```php +public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает персональные данные получателя выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null | value | Персональные данные получателя выплаты | + +**Returns:** $this - + + #### public getMetadata() : \YooKassa\Model\Metadata @@ -402,11 +650,11 @@ public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestSerializer.md b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestSerializer.md index 34245ef4..026a4a41 100644 --- a/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Payouts\CreatePayoutRequestInterface $request ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-CreatePayoutResponse.md b/docs/classes/YooKassa-Request-Payouts-CreatePayoutResponse.md index b6439d35..6874180e 100644 --- a/docs/classes/YooKassa-Request-Payouts-CreatePayoutResponse.md +++ b/docs/classes/YooKassa-Request-Payouts-CreatePayoutResponse.md @@ -29,6 +29,9 @@ | public | [$metadata](../classes/YooKassa-Model-Payout.md#property_metadata) | | Метаданные выплаты указанные мерчантом | | public | [$payout_destination](../classes/YooKassa-Model-Payout.md#property_payout_destination) | | Способ проведения выплаты | | public | [$payoutDestination](../classes/YooKassa-Model-Payout.md#property_payoutDestination) | | Способ проведения выплаты | +| public | [$receipt](../classes/YooKassa-Model-Payout.md#property_receipt) | | Данные чека, зарегистрированного в ФНС | +| public | [$self_employed](../classes/YooKassa-Model-Payout.md#property_self_employed) | | Данные самозанятого, который получит выплату | +| public | [$selfEmployed](../classes/YooKassa-Model-Payout.md#property_selfEmployed) | | Данные самозанятого, который получит выплату | | public | [$status](../classes/YooKassa-Model-Payout.md#property_status) | | Текущее состояние выплаты | | public | [$test](../classes/YooKassa-Model-Payout.md#property_test) | | Признак тестовой операции | @@ -50,13 +53,15 @@ | public | [getId()](../classes/YooKassa-Model-Payout.md#method_getId) | | Возвращает идентификатор выплаты | | public | [getMetadata()](../classes/YooKassa-Model-Payout.md#method_getMetadata) | | Возвращает метаданные выплаты установленные мерчантом | | public | [getPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_getPayoutDestination) | | Возвращает используемый способ проведения выплаты | +| public | [getReceipt()](../classes/YooKassa-Model-Payout.md#method_getReceipt) | | Возвращает данные чека, зарегистрированного в ФНС. | +| public | [getSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [getStatus()](../classes/YooKassa-Model-Payout.md#method_getStatus) | | Возвращает состояние выплаты | | public | [getTest()](../classes/YooKassa-Model-Payout.md#method_getTest) | | Возвращает признак тестовой операции | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payout.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payout.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | | public | [setCreatedAt()](../classes/YooKassa-Model-Payout.md#method_setCreatedAt) | | Устанавливает время создания заказа | @@ -65,6 +70,8 @@ | public | [setId()](../classes/YooKassa-Model-Payout.md#method_setId) | | Устанавливает идентификатор выплаты | | public | [setMetadata()](../classes/YooKassa-Model-Payout.md#method_setMetadata) | | Устанавливает метаданные выплаты | | public | [setPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_setPayoutDestination) | | Устанавливает используемый способ проведения выплаты | +| public | [setReceipt()](../classes/YooKassa-Model-Payout.md#method_setReceipt) | | Устанавливает данные чека, зарегистрированного в ФНС. | +| public | [setSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | public | [setStatus()](../classes/YooKassa-Model-Payout.md#method_setStatus) | | Устанавливает статус выплаты | | public | [setTest()](../classes/YooKassa-Model-Payout.md#method_setTest) | | Устанавливает признак тестовой операции | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -103,7 +110,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сумма выплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -116,7 +123,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -129,7 +136,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -168,7 +175,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сделка, в рамках которой нужно провести выплату -**Type:** PayoutDealInfo +**Type:** PayoutDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -181,7 +188,7 @@ MAX_LENGTH_DESCRIPTION = 128 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -194,7 +201,7 @@ MAX_LENGTH_DESCRIPTION = 128 Идентификатор выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -207,7 +214,7 @@ MAX_LENGTH_DESCRIPTION = 128 Метаданные выплаты указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -220,7 +227,7 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -233,7 +240,46 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $receipt : \YooKassa\Model\Payout\IncomeReceipt +--- +***Description*** + +Данные чека, зарегистрированного в ФНС + +**Type:** IncomeReceipt + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $self_employed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $selfEmployed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -246,7 +292,7 @@ MAX_LENGTH_DESCRIPTION = 128 Текущее состояние выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -259,7 +305,7 @@ MAX_LENGTH_DESCRIPTION = 128 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -541,6 +587,40 @@ public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMet **Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения выплаты + +#### public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null + +```php +public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null +``` + +**Summary** + +Возвращает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\IncomeReceipt|null - Данные чека, зарегистрированного в ФНС + + + +#### public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null + +```php +public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\PayoutSelfEmployed|null - Данные самозанятого, который получит выплату + + #### public getStatus() : string @@ -576,116 +656,96 @@ public getTest() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - #### public setAmount() : mixed ```php -public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : mixed ``` **Summary** @@ -698,7 +758,7 @@ public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма выплаты | **Returns:** mixed - @@ -758,7 +818,7 @@ public setCreatedAt(\DateTime|string|int $value) : mixed #### public setDeal() : mixed ```php -public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed +public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed ``` **Summary** @@ -771,7 +831,7 @@ public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Deal\PayoutDealInfo OR array | value | Сделка, в рамках которой нужно провести выплату | +| \YooKassa\Model\Deal\PayoutDealInfo OR array OR null | value | Сделка, в рамках которой нужно провести выплату | **Returns:** mixed - @@ -836,7 +896,7 @@ public setId(string $value) : mixed #### public setMetadata() : mixed ```php -public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed +public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ``` **Summary** @@ -849,7 +909,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Metadata OR array | value | Метаданные выплаты указанные мерчантом | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные выплаты указанные мерчантом | **Returns:** mixed - @@ -858,7 +918,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed #### public setPayoutDestination() : mixed ```php -public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array $value) : mixed +public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed ``` **Summary** @@ -871,11 +931,55 @@ public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|arr ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Payout\AbstractPayoutDestination OR array | value | Способ проведения выплаты | +| \YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null | value | Способ проведения выплаты | **Returns:** mixed - + +#### public setReceipt() : $this + +```php +public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\IncomeReceipt OR array OR null | value | Данные чека, зарегистрированного в ФНС | + +**Returns:** $this - + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\PayoutSelfEmployed OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + #### public setStatus() : mixed @@ -972,11 +1076,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-IncomeReceiptData.md b/docs/classes/YooKassa-Request-Payouts-IncomeReceiptData.md new file mode 100644 index 00000000..ff325eee --- /dev/null +++ b/docs/classes/YooKassa-Request-Payouts-IncomeReceiptData.md @@ -0,0 +1,453 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payouts\IncomeReceiptData +### Namespace: [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) +--- +**Summary:** + +Класс, представляющий модель IncomeReceiptData. + +**Description:** + +Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#property_amount) | | Сумма для печати в чеке | +| public | [$service_name](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#property_service_name) | | Описание услуги, оказанной получателем выплаты. Не более 50 символов | +| public | [$serviceName](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#property_serviceName) | | Описание услуги, оказанной получателем выплаты. Не более 50 символов | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#method_getAmount) | | Возвращает сумму для печати в чеке. | +| public | [getServiceName()](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#method_getServiceName) | | Возвращает описание услуги, оказанной получателем выплаты. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setAmount()](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#method_setAmount) | | Устанавливает сумму для печати в чеке. | +| public | [setServiceName()](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md#method_setServiceName) | | Устанавливает описание услуги, оказанной получателем выплаты. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/Payouts/IncomeReceiptData.php](../../lib/Request/Payouts/IncomeReceiptData.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Payouts\IncomeReceiptData + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма для печати в чеке + +**Type:** AmountInterface + +**Details:** + + + +#### public $service_name : string +--- +***Description*** + +Описание услуги, оказанной получателем выплаты. Не более 50 символов + +**Type:** string + +**Details:** + + + +#### public $serviceName : string +--- +***Description*** + +Описание услуги, оказанной получателем выплаты. Не более 50 символов + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface|null + +```php +public getAmount() : \YooKassa\Model\AmountInterface|null +``` + +**Summary** + +Возвращает сумму для печати в чеке. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\IncomeReceiptData](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md) + +**Returns:** \YooKassa\Model\AmountInterface|null - Сумма для печати в чеке + + + +#### public getServiceName() : string + +```php +public getServiceName() : string +``` + +**Summary** + +Возвращает описание услуги, оказанной получателем выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\IncomeReceiptData](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md) + +**Returns:** string - Описание услуги, оказанной получателем выплаты + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setAmount() : $this + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает сумму для печати в чеке. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\IncomeReceiptData](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма для печати в чеке | + +**Returns:** $this - + + + +#### public setServiceName() : $this + +```php +public setServiceName(string $value) : $this +``` + +**Summary** + +Устанавливает описание услуги, оказанной получателем выплаты. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\IncomeReceiptData](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Описание услуги, оказанной получателем выплаты | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md index 866a7b61..179dc586 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md @@ -30,19 +30,19 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php](../../lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -57,7 +57,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** @@ -69,7 +69,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -229,109 +229,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -352,28 +332,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -391,6 +349,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -402,11 +382,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md index e0234700..793115a1 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md @@ -33,20 +33,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getCard()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md#method_getCard) | | Возвращает данные банковской карты | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCard()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md#method_setCard) | | Устанавливает данные банковской карты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php](../../lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -62,7 +62,7 @@ Данные банковской карты -**Type:** PayoutDestinationDataBankCardCard +**Type:** PayoutDestinationDataBankCardCard **Details:** @@ -74,7 +74,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData](../classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md) @@ -87,7 +87,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -255,109 +255,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -400,28 +380,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -439,6 +397,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -450,11 +430,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md index 3fefd09f..08bb072d 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md @@ -32,11 +32,11 @@ | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getNumber()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md#method_getNumber) | | Возвращает последние 4 цифры номера карты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setNumber()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md#method_setNumber) | | Устанавливает последние 4 цифры номера карты | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | @@ -44,7 +44,7 @@ --- ### Details * File: [lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php](../../lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataBankCardCard @@ -58,7 +58,7 @@ Номер банковской карты. Формат: только цифры, без пробелов. -**Type:** string +**Type:** string **Details:** @@ -217,109 +217,89 @@ public getNumber() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -390,11 +370,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataFactory.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataFactory.md index fa2e2c22..ab7f3c5e 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataFactory.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataFactory.md @@ -87,11 +87,11 @@ public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Reque ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md new file mode 100644 index 00000000..14ceda24 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md @@ -0,0 +1,522 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp +### Namespace: [\YooKassa\Request\Payouts\PayoutDestinationData](../namespaces/yookassa-request-payouts-payoutdestinationdata.md) +--- +**Summary:** + +Класс PayoutDestinationDataSbp + +**Description:** + +Метод оплаты, при оплате через ЮMoney + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$bank_id](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#property_bank_id) | | Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису | +| public | [$bankId](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#property_bankId) | | Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису | +| public | [$phone](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#property_phone) | | Телефон, к которому привязан счет получателя выплаты в системе участника СБП | +| public | [$type](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#property_type) | | Тип объекта | +| public | [$type](../classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md#property_type) | | Тип метода оплаты | +| public | [$type](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#property_type) | | Тип метода оплаты | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getBankId()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#method_getBankId) | | Возвращает идентификатор выбранного участника СБП. | +| public | [getPhone()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#method_getPhone) | | Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. | +| public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setBankId()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#method_setBankId) | | Устанавливает идентификатор выбранного участника СБП. | +| public | [setPhone()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md#method_setPhone) | | Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | + +--- +### Details +* File: [lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataSbp.php](../../lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataSbp.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + * [\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData](../classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md) + * \YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp + +--- +## Properties + +#### public $bank_id : string +--- +***Description*** + +Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису + +**Type:** string + +**Details:** + + + +#### public $bankId : string +--- +***Description*** + +Идентификатор выбранного участника СБП — банка или платежного сервиса, подключенного к сервису + +**Type:** string + +**Details:** + + + +#### public $phone : string +--- +***Description*** + +Телефон, к которому привязан счет получателя выплаты в системе участника СБП + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData](../classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md) + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getBankId() : string + +```php +public getBankId() : string +``` + +**Summary** + +Возвращает идентификатор выбранного участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) + +**Returns:** string - Идентификатор выбранного участника СБП + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) + +**Returns:** string - Телефон, к которому привязан счет получателя выплаты в системе участника СБП + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setBankId() : $this + +```php +public setBankId(string $bankId) : $this +``` + +**Summary** + +Устанавливает идентификатор выбранного участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bankId | Идентификатор выбранного участника СБП | + +**Returns:** $this - + + + +#### public setPhone() : $this + +```php +public setPhone(string $phone) : $this +``` + +**Summary** + +Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | phone | Телефон, к которому привязан счет получателя выплаты в системе участника СБП | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md index e737f6f5..3d9b35a2 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md @@ -37,20 +37,20 @@ | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAccountNumber()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md#method_getAccountNumber) | | Возвращает номер кошелька в ЮMoney, с которого была произведена оплата | | public | [getType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_getType) | | Возвращает тип метода оплаты | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAccountNumber()](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md#method_setAccountNumber) | | Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | -| protected | [_setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method__setType) | | Устанавливает тип метода оплаты | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md#method_setType) | | Устанавливает тип метода оплаты | --- ### Details * File: [lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php](../../lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -66,7 +66,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -78,7 +78,7 @@ Номер кошелька в ЮMoney, с которого была произведена оплата -**Type:** string +**Type:** string **Details:** @@ -90,7 +90,7 @@ Тип объекта -**Type:** string +**Type:** string **Details:** @@ -102,7 +102,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData](../classes/YooKassa-Request-Payouts-PayoutDestinationData-AbstractPayoutDestinationData.md) @@ -115,7 +115,7 @@ Тип метода оплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) @@ -283,109 +283,89 @@ public getType() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -428,28 +408,6 @@ public toArray() : array **Returns:** array - Ассоциативный массив со свойствами текущего объекта - -#### protected _setType() : mixed - -```php -protected _setType(string $value) : mixed -``` - -**Summary** - -Устанавливает тип метода оплаты - -**Details:** -* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) - -##### Parameters: -| Type | Name | Description | -| ---- | ---- | ----------- | -| string | value | Тип метода оплаты | - -**Returns:** mixed - - - #### protected getUnknownProperties() : array @@ -467,6 +425,28 @@ protected getUnknownProperties() : array **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + --- @@ -478,11 +458,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutPersonalData.md b/docs/classes/YooKassa-Request-Payouts-PayoutPersonalData.md new file mode 100644 index 00000000..8c025a0e --- /dev/null +++ b/docs/classes/YooKassa-Request-Payouts-PayoutPersonalData.md @@ -0,0 +1,365 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payouts\PayoutPersonalData +### Namespace: [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) +--- +**Summary:** + +Класс, представляющий модель PayoutsPersonalData. + +**Description:** + +Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплату с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check). Только для обычных выплат. + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Request-Payouts-PayoutPersonalData.md#method_getId) | | Возвращает идентификатор персональных данных. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setId()](../classes/YooKassa-Request-Payouts-PayoutPersonalData.md#method_setId) | | Устанавливает идентификатор персональных данных. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/Payouts/PayoutPersonalData.php](../../lib/Request/Payouts/PayoutPersonalData.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Payouts\PayoutPersonalData + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutPersonalData](../classes/YooKassa-Request-Payouts-PayoutPersonalData.md) + +**Returns:** string - Идентификатор персональных данных + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutPersonalData](../classes/YooKassa-Request-Payouts-PayoutPersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор персональных данных | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutResponse.md b/docs/classes/YooKassa-Request-Payouts-PayoutResponse.md index eff9cffc..d3286f6c 100644 --- a/docs/classes/YooKassa-Request-Payouts-PayoutResponse.md +++ b/docs/classes/YooKassa-Request-Payouts-PayoutResponse.md @@ -29,6 +29,9 @@ | public | [$metadata](../classes/YooKassa-Model-Payout.md#property_metadata) | | Метаданные выплаты указанные мерчантом | | public | [$payout_destination](../classes/YooKassa-Model-Payout.md#property_payout_destination) | | Способ проведения выплаты | | public | [$payoutDestination](../classes/YooKassa-Model-Payout.md#property_payoutDestination) | | Способ проведения выплаты | +| public | [$receipt](../classes/YooKassa-Model-Payout.md#property_receipt) | | Данные чека, зарегистрированного в ФНС | +| public | [$self_employed](../classes/YooKassa-Model-Payout.md#property_self_employed) | | Данные самозанятого, который получит выплату | +| public | [$selfEmployed](../classes/YooKassa-Model-Payout.md#property_selfEmployed) | | Данные самозанятого, который получит выплату | | public | [$status](../classes/YooKassa-Model-Payout.md#property_status) | | Текущее состояние выплаты | | public | [$test](../classes/YooKassa-Model-Payout.md#property_test) | | Признак тестовой операции | @@ -50,13 +53,15 @@ | public | [getId()](../classes/YooKassa-Model-Payout.md#method_getId) | | Возвращает идентификатор выплаты | | public | [getMetadata()](../classes/YooKassa-Model-Payout.md#method_getMetadata) | | Возвращает метаданные выплаты установленные мерчантом | | public | [getPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_getPayoutDestination) | | Возвращает используемый способ проведения выплаты | +| public | [getReceipt()](../classes/YooKassa-Model-Payout.md#method_getReceipt) | | Возвращает данные чека, зарегистрированного в ФНС. | +| public | [getSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [getStatus()](../classes/YooKassa-Model-Payout.md#method_getStatus) | | Возвращает состояние выплаты | | public | [getTest()](../classes/YooKassa-Model-Payout.md#method_getTest) | | Возвращает признак тестовой операции | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Payout.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setCancellationDetails()](../classes/YooKassa-Model-Payout.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | | public | [setCreatedAt()](../classes/YooKassa-Model-Payout.md#method_setCreatedAt) | | Устанавливает время создания заказа | @@ -65,6 +70,8 @@ | public | [setId()](../classes/YooKassa-Model-Payout.md#method_setId) | | Устанавливает идентификатор выплаты | | public | [setMetadata()](../classes/YooKassa-Model-Payout.md#method_setMetadata) | | Устанавливает метаданные выплаты | | public | [setPayoutDestination()](../classes/YooKassa-Model-Payout.md#method_setPayoutDestination) | | Устанавливает используемый способ проведения выплаты | +| public | [setReceipt()](../classes/YooKassa-Model-Payout.md#method_setReceipt) | | Устанавливает данные чека, зарегистрированного в ФНС. | +| public | [setSelfEmployed()](../classes/YooKassa-Model-Payout.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | | public | [setStatus()](../classes/YooKassa-Model-Payout.md#method_setStatus) | | Устанавливает статус выплаты | | public | [setTest()](../classes/YooKassa-Model-Payout.md#method_setTest) | | Устанавливает признак тестовой операции | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | @@ -103,7 +110,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сумма выплаты -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -116,7 +123,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -129,7 +136,7 @@ MAX_LENGTH_DESCRIPTION = 128 Комментарий к отмене выплаты -**Type:** CancellationDetailsInterface +**Type:** CancellationDetailsInterface **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -168,7 +175,7 @@ MAX_LENGTH_DESCRIPTION = 128 Сделка, в рамках которой нужно провести выплату -**Type:** PayoutDealInfo +**Type:** PayoutDealInfo **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -181,7 +188,7 @@ MAX_LENGTH_DESCRIPTION = 128 Описание транзакции -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -194,7 +201,7 @@ MAX_LENGTH_DESCRIPTION = 128 Идентификатор выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -207,7 +214,7 @@ MAX_LENGTH_DESCRIPTION = 128 Метаданные выплаты указанные мерчантом -**Type:** Metadata +**Type:** Metadata **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -220,7 +227,7 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -233,7 +240,46 @@ MAX_LENGTH_DESCRIPTION = 128 Способ проведения выплаты -**Type:** AbstractPaymentMethod +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $receipt : \YooKassa\Model\Payout\IncomeReceipt +--- +***Description*** + +Данные чека, зарегистрированного в ФНС + +**Type:** IncomeReceipt + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $self_employed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + + + +#### public $selfEmployed : \YooKassa\Model\Payout\PayoutSelfEmployed +--- +***Description*** + +Данные самозанятого, который получит выплату + +**Type:** PayoutSelfEmployed **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -246,7 +292,7 @@ MAX_LENGTH_DESCRIPTION = 128 Текущее состояние выплаты -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -259,7 +305,7 @@ MAX_LENGTH_DESCRIPTION = 128 Признак тестовой операции -**Type:** bool +**Type:** bool **Details:** * Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) @@ -541,6 +587,40 @@ public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMet **Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения выплаты + +#### public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null + +```php +public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null +``` + +**Summary** + +Возвращает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\IncomeReceipt|null - Данные чека, зарегистрированного в ФНС + + + +#### public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null + +```php +public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null +``` + +**Summary** + +Возвращает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +**Returns:** \YooKassa\Model\Payout\PayoutSelfEmployed|null - Данные самозанятого, который получит выплату + + #### public getStatus() : string @@ -576,116 +656,96 @@ public getTest() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - #### public setAmount() : mixed ```php -public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed +public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : mixed ``` **Summary** @@ -698,7 +758,7 @@ public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма выплаты | **Returns:** mixed - @@ -758,7 +818,7 @@ public setCreatedAt(\DateTime|string|int $value) : mixed #### public setDeal() : mixed ```php -public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed +public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed ``` **Summary** @@ -771,7 +831,7 @@ public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Deal\PayoutDealInfo OR array | value | Сделка, в рамках которой нужно провести выплату | +| \YooKassa\Model\Deal\PayoutDealInfo OR array OR null | value | Сделка, в рамках которой нужно провести выплату | **Returns:** mixed - @@ -836,7 +896,7 @@ public setId(string $value) : mixed #### public setMetadata() : mixed ```php -public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed +public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ``` **Summary** @@ -849,7 +909,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Metadata OR array | value | Метаданные выплаты указанные мерчантом | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные выплаты указанные мерчантом | **Returns:** mixed - @@ -858,7 +918,7 @@ public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed #### public setPayoutDestination() : mixed ```php -public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array $value) : mixed +public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed ``` **Summary** @@ -871,11 +931,55 @@ public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|arr ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\Payout\AbstractPayoutDestination OR array | value | Способ проведения выплаты | +| \YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null | value | Способ проведения выплаты | **Returns:** mixed - + +#### public setReceipt() : $this + +```php +public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные чека, зарегистрированного в ФНС. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\IncomeReceipt OR array OR null | value | Данные чека, зарегистрированного в ФНС | + +**Returns:** $this - + + + +#### public setSelfEmployed() : $this + +```php +public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $value = null) : $this +``` + +**Summary** + +Устанавливает данные самозанятого, который получит выплату. + +**Details:** +* Inherited From: [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Payout\PayoutSelfEmployed OR array OR null | value | Данные самозанятого, который получит выплату | + +**Returns:** $this - + + #### public setStatus() : mixed @@ -972,11 +1076,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md b/docs/classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md new file mode 100644 index 00000000..befc984b --- /dev/null +++ b/docs/classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md @@ -0,0 +1,386 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payouts\PayoutSelfEmployedInfo +### Namespace: [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) +--- +**Summary:** + +Класс, представляющий модель PayoutSelfEmployedInfo. + +**Description:** + +Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md#property_id) | | Идентификатор самозанятого в ЮKassa | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md#method_getId) | | Возвращает идентификатор самозанятого. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setId()](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md#method_setId) | | Устанавливает идентификатор самозанятого. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/Payouts/PayoutSelfEmployedInfo.php](../../lib/Request/Payouts/PayoutSelfEmployedInfo.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Payouts\PayoutSelfEmployedInfo + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор самозанятого в ЮKassa + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutSelfEmployedInfo](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md) + +**Returns:** string - Идентификатор самозанятого + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\PayoutSelfEmployedInfo](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор самозанятого в ЮKassa. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payouts-SbpBanksResponse.md b/docs/classes/YooKassa-Request-Payouts-SbpBanksResponse.md new file mode 100644 index 00000000..ddb8942c --- /dev/null +++ b/docs/classes/YooKassa-Request-Payouts-SbpBanksResponse.md @@ -0,0 +1,388 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payouts\SbpBanksResponse +### Namespace: [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) +--- +**Summary:** + +Класс, представляющий модель GetSbpBanksResponse. + +**Description:** + +Список участников СБП, отсортированный по идентификатору участника в порядке убывания (desc) + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md#method_fromArray) | | Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива | +| public | [getItems()](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md#method_getItems) | | Возвращает items. | +| public | [getType()](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md#method_getType) | | Возвращает type. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setType()](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md#method_setType) | | Устанавливает type. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/Payouts/SbpBanksResponse.php](../../lib/Request/Payouts/SbpBanksResponse.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Payouts\SbpBanksResponse + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array $sourceArray) : mixed +``` + +**Summary** + +Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\SbpBanksResponse](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | sourceArray | Массив настроек, пришедший от API | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public getItems() : \YooKassa\Model\Payout\SbpParticipantBank[]|array + +```php +public getItems() : \YooKassa\Model\Payout\SbpParticipantBank[]|array +``` + +**Summary** + +Возвращает items. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\SbpBanksResponse](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md) + +**Returns:** \YooKassa\Model\Payout\SbpParticipantBank[]|array - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает type. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\SbpBanksResponse](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает type. + +**Details:** +* Inherited From: [\YooKassa\Request\Payouts\SbpBanksResponse](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Формат выдачи результатов запроса. Возможное значение: `list` (список). | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md new file mode 100644 index 00000000..95d4c3c6 --- /dev/null +++ b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md @@ -0,0 +1,850 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequest +### Namespace: [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель CreatePersonalDataRequest. + + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_LAST_NAME](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#constant_MAX_LENGTH_LAST_NAME) | | Максимальная длина строки фамилии или отчества | +| public | [MAX_LENGTH_FIRST_NAME](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#constant_MAX_LENGTH_FIRST_NAME) | | Максимальная длина строки имени | + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$first_name](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_first_name) | | Имя пользователя | +| public | [$firstName](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_firstName) | | Имя пользователя | +| public | [$last_name](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_last_name) | | Фамилия пользователя | +| public | [$lastName](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_lastName) | | Фамилия пользователя | +| public | [$metadata](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_metadata) | | Метаданные персональных данных указанные мерчантом | +| public | [$middle_name](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_middle_name) | | Отчество пользователя | +| public | [$middleName](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_middleName) | | Отчество пользователя | +| public | [$type](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#property_type) | | Тип персональных данных | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_builder) | | Возвращает билдер объектов запросов создания платежа | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_getFirstName) | | Возвращает имя пользователя. | +| public | [getLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_getLastName) | | Возвращает фамилию пользователя. | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_getMetadata) | | Возвращает метаданные. | +| public | [getMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_getMiddleName) | | Возвращает отчество пользователя. | +| public | [getType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_getType) | | Возвращает тип персональных данных. | +| public | [hasFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_hasFirstName) | | Проверяет наличие имени пользователя в запросе | +| public | [hasLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_hasLastName) | | Проверяет наличие фамилии пользователя в запросе | +| public | [hasMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные | +| public | [hasMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_hasMiddleName) | | Проверяет наличие отчества пользователя в запросе | +| public | [hasType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_hasType) | | Проверяет наличие типа персональных данных в запросе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_setFirstName) | | Устанавливает имя пользователя. | +| public | [setLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_setLastName) | | Устанавливает фамилию пользователя. | +| public | [setMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_setMetadata) | | Устанавливает метаданные. | +| public | [setMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_setMiddleName) | | Устанавливает отчество пользователя. | +| public | [setType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_setType) | | Устанавливает тип персональных данных. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md#method_validate) | | Проверяет на валидность текущий объект | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | + +--- +### Details +* File: [lib/Request/PersonalData/CreatePersonalDataRequest.php](../../lib/Request/PersonalData/CreatePersonalDataRequest.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\PersonalData\CreatePersonalDataRequest +* Implements: + * [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Constants + +###### MAX_LENGTH_LAST_NAME +Максимальная длина строки фамилии или отчества + +```php +MAX_LENGTH_LAST_NAME = 200 +``` + + + +###### MAX_LENGTH_FIRST_NAME +Максимальная длина строки имени + +```php +MAX_LENGTH_FIRST_NAME = 100 +``` + + + +--- +## Properties + +#### public $first_name : string +--- +***Description*** + +Имя пользователя + +**Type:** string + +**Details:** + + + +#### public $firstName : string +--- +***Description*** + +Имя пользователя + +**Type:** string + +**Details:** + + + +#### public $last_name : string +--- +***Description*** + +Фамилия пользователя + +**Type:** string + +**Details:** + + + +#### public $lastName : string +--- +***Description*** + +Фамилия пользователя + +**Type:** string + +**Details:** + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные персональных данных указанные мерчантом + +**Type:** Metadata + +**Details:** + + + +#### public $middle_name : string +--- +***Description*** + +Отчество пользователя + +**Type:** string + +**Details:** + + + +#### public $middleName : string +--- +***Description*** + +Отчество пользователя + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип персональных данных + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder + +```php +Static public builder() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов запросов создания платежа + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder - Инстанс билдера объектов запросов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFirstName() : string + +```php +public getFirstName() : string +``` + +**Summary** + +Возвращает имя пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** string - Имя пользователя + + + +#### public getLastName() : string + +```php +public getLastName() : string +``` + +**Summary** + +Возвращает фамилию пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** string - Фамилия пользователя + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные + + + +#### public getMiddleName() : string|null + +```php +public getMiddleName() : string|null +``` + +**Summary** + +Возвращает отчество пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** string|null - Отчество пользователя + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** string - Тип персональных данных + + + +#### public hasFirstName() : bool + +```php +public hasFirstName() : bool +``` + +**Summary** + +Проверяет наличие имени пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если имя пользователя задано, false если нет + + + +#### public hasLastName() : bool + +```php +public hasLastName() : bool +``` + +**Summary** + +Проверяет наличие фамилии пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если фамилия пользователя задана, false если нет + + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет, были ли установлены метаданные + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + + + +#### public hasMiddleName() : bool + +```php +public hasMiddleName() : bool +``` + +**Summary** + +Проверяет наличие отчества пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если отчество пользователя задано, false если нет + + + +#### public hasType() : bool + +```php +public hasType() : bool +``` + +**Summary** + +Проверяет наличие типа персональных данных в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если тип персональных данных задан, false если нет + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setFirstName() : $this + +```php +public setFirstName(string $first_name) : $this +``` + +**Summary** + +Устанавливает имя пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | first_name | Имя пользователя. | + +**Returns:** $this - + + + +#### public setLastName() : $this + +```php +public setLastName(string $last_name) : $this +``` + +**Summary** + +Устанавливает фамилию пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | last_name | Фамилия пользователя. | + +**Returns:** $this - + + + +#### public setMetadata() : $this + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this +``` + +**Summary** + +Устанавливает метаданные. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | metadata | Метаданные | + +**Returns:** $this - + + + +#### public setMiddleName() : $this + +```php +public setMiddleName(string|null $middle_name = null) : $this +``` + +**Summary** + +Устанавливает отчество пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | middle_name | Отчество пользователя | + +**Returns:** $this - + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип персональных данных | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет на валидность текущий объект + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) + +**Returns:** bool - True если объект запроса валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string $value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md new file mode 100644 index 00000000..4ff1ed1d --- /dev/null +++ b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md @@ -0,0 +1,290 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder +### Namespace: [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) +--- +**Summary:** + +Класс билдера объектов запросов к API на создание платежа + + +--- +### Examples +02-builder.php 11 78 Пример использования билдера + +```php + +``` + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_build) | | Строит и возвращает объект запроса для отправки в API ЮKassa | +| public | [setFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_setFirstName) | | Устанавливает имя пользователя. | +| public | [setLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_setLastName) | | Устанавливает фамилию пользователя. | +| public | [setMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | +| public | [setMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_setMiddleName) | | Устанавливает отчество пользователя. | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_setType) | | Устанавливает тип персональных данных. | +| protected | [initCurrentObject()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером | + +--- +### Details +* File: [lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php](../../lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder + +--- +## Properties + +#### protected $currentObject : \YooKassa\Request\PersonalData\CreatePersonalDataRequest +--- +**Summary** + +Собираемый объект запроса + +**Type:** CreatePersonalDataRequest + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest + +```php +public build(array|null $options = null) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит и возвращает объект запроса для отправки в API ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив параметров для установки в объект запроса | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось | + +**Returns:** \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Request\PersonalData\CreatePersonalDataRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса + + + +#### public setFirstName() : self + +```php +public setFirstName(string $value) : self +``` + +**Summary** + +Устанавливает имя пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Имя пользователя. | + +**Returns:** self - + + + +#### public setLastName() : self + +```php +public setLastName(string $value) : self +``` + +**Summary** + +Устанавливает фамилию пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Фамилия пользователя. | + +**Returns:** self - + + + +#### public setMetadata() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $value) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder +``` + +**Summary** + +Устанавливает метаданные, привязанные к платежу + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные платежа, устанавливаемые мерчантом | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа | + +**Returns:** \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder - Инстанс текущего билдера + + + +#### public setMiddleName() : self + +```php +public setMiddleName(string $value) : self +``` + +**Summary** + +Устанавливает отчество пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Отчество пользователя. | + +**Returns:** self - + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setType() : self + +```php +public setType(string $value) : self +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип персональных данных | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest + +```php +protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest +``` + +**Summary** + +Инициализирует объект запроса, который в дальнейшем будет собираться билдером + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) + +**Returns:** \YooKassa\Request\PersonalData\CreatePersonalDataRequest - Инстанс собираемого объекта запроса к API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md new file mode 100644 index 00000000..b47bf703 --- /dev/null +++ b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md @@ -0,0 +1,382 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CreatePersonalDataRequestInterface +### Namespace: [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) +--- +**Summary:** + +Класс, представляющий интерфейс SbpPayoutRecipientPersonalDataRequestInterface. + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_getFirstName) | | Возвращает имя пользователя. | +| public | [getLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_getLastName) | | Возвращает фамилию пользователя. | +| public | [getMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_getMetadata) | | Возвращает метаданные. | +| public | [getMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_getMiddleName) | | Возвращает отчество пользователя. | +| public | [getType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_getType) | | Возвращает тип персональных данных. | +| public | [hasFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_hasFirstName) | | Проверяет наличие имени пользователя в запросе | +| public | [hasLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_hasLastName) | | Проверяет наличие фамилии пользователя в запросе | +| public | [hasMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные | +| public | [hasMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_hasMiddleName) | | Проверяет наличие отчества пользователя в запросе | +| public | [hasType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_hasType) | | Проверяет наличие типа персональных данных в запросе | +| public | [setFirstName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_setFirstName) | | Устанавливает имя пользователя. | +| public | [setLastName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_setLastName) | | Устанавливает фамилию пользователя. | +| public | [setMetadata()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_setMetadata) | | Устанавливает метаданные. | +| public | [setMiddleName()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_setMiddleName) | | Устанавливает отчество пользователя. | +| public | [setType()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_setType) | | Устанавливает тип персональных данных. | +| public | [toArray()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [validate()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md#method_validate) | | Проверяет на валидность текущий объект | + +--- +### Details +* File: [lib/Request/PersonalData/CreatePersonalDataRequestInterface.php](../../lib/Request/PersonalData/CreatePersonalDataRequestInterface.php) +* Package: \YooKassa\Model + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** string - Тип персональных данных + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип персональных данных | + +**Returns:** $this - + + + +#### public hasType() : bool + +```php +public hasType() : bool +``` + +**Summary** + +Проверяет наличие типа персональных данных в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если тип персональных данных задан, false если нет + + + +#### public getLastName() : string + +```php +public getLastName() : string +``` + +**Summary** + +Возвращает фамилию пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** string - Фамилия пользователя + + + +#### public setLastName() : $this + +```php +public setLastName(string $last_name) : $this +``` + +**Summary** + +Устанавливает фамилию пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | last_name | Фамилия пользователя. | + +**Returns:** $this - + + + +#### public hasLastName() : bool + +```php +public hasLastName() : bool +``` + +**Summary** + +Проверяет наличие фамилии пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если фамилия пользователя задана, false если нет + + + +#### public getFirstName() : string + +```php +public getFirstName() : string +``` + +**Summary** + +Возвращает имя пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** string - Имя пользователя + + + +#### public setFirstName() : $this + +```php +public setFirstName(string $first_name) : $this +``` + +**Summary** + +Устанавливает имя пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | first_name | Имя пользователя. | + +**Returns:** $this - + + + +#### public hasFirstName() : bool + +```php +public hasFirstName() : bool +``` + +**Summary** + +Проверяет наличие имени пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если имя пользователя задано, false если нет + + + +#### public getMiddleName() : string|null + +```php +public getMiddleName() : string|null +``` + +**Summary** + +Возвращает отчество пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** string|null - Отчество пользователя + + + +#### public setMiddleName() : $this + +```php +public setMiddleName(string|null $middle_name = null) : $this +``` + +**Summary** + +Устанавливает отчество пользователя. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | middle_name | Отчество пользователя | + +**Returns:** $this - + + + +#### public hasMiddleName() : bool + +```php +public hasMiddleName() : bool +``` + +**Summary** + +Проверяет наличие отчества пользователя в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если отчество пользователя задано, false если нет + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные + + + +#### public setMetadata() : $this + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this +``` + +**Summary** + +Устанавливает метаданные. + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | metadata | Метаданные | + +**Returns:** $this - + + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет, были ли установлены метаданные + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет на валидность текущий объект + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** bool - True если объект запроса валиден, false если нет + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md new file mode 100644 index 00000000..1cd78f89 --- /dev/null +++ b/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md @@ -0,0 +1,70 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequestSerializer +### Namespace: [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) +--- +**Summary:** + +Класс сериалайзера объекта запроса к API на проведение выплаты + + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md#method_serialize) | | Формирует ассоциативный массив данных из объекта запроса | + +--- +### Details +* File: [lib/Request/PersonalData/CreatePersonalDataRequestSerializer.php](../../lib/Request/PersonalData/CreatePersonalDataRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\PersonalData\CreatePersonalDataRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface $request) : array +``` + +**Summary** + +Формирует ассоциативный массив данных из объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\PersonalData\CreatePersonalDataRequestSerializer](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface | request | Объект запроса | + +**Returns:** array - Массив данных для дальнейшего кодирования в JSON + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-PersonalData-PersonalDataResponse.md b/docs/classes/YooKassa-Request-PersonalData-PersonalDataResponse.md new file mode 100644 index 00000000..eac56db5 --- /dev/null +++ b/docs/classes/YooKassa-Request-PersonalData-PersonalDataResponse.md @@ -0,0 +1,770 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\PersonalData\PersonalDataResponse +### Namespace: [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) +--- +**Summary:** + +Класс, представляющий модель PersonalData. + +**Description:** + +Информация о персональных данных + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$cancellation_details](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_cancellation_details) | | Комментарий к отмене выплаты | +| public | [$cancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_cancellationDetails) | | Комментарий к отмене выплаты | +| public | [$created_at](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_created_at) | | Время создания персональных данных | +| public | [$createdAt](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_createdAt) | | Время создания персональных данных | +| public | [$expires_at](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_expires_at) | | Срок жизни объекта персональных данных | +| public | [$expiresAt](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_expiresAt) | | Срок жизни объекта персональных данных | +| public | [$id](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_id) | | Идентификатор персональных данных | +| public | [$metadata](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_metadata) | | Метаданные выплаты указанные мерчантом | +| public | [$status](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_status) | | Текущий статус персональных данных | +| public | [$type](../classes/YooKassa-Model-PersonalData-PersonalData.md#property_type) | | Тип персональных данных | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getCancellationDetails) | | Возвращает cancellation_details. | +| public | [getCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getCreatedAt) | | Возвращает created_at. | +| public | [getExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getExpiresAt) | | Возвращает срок жизни объекта персональных данных. | +| public | [getId()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getId) | | Возвращает id. | +| public | [getMetadata()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getMetadata) | | Возвращает любые дополнительные данные. | +| public | [getStatus()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getStatus) | | Возвращает статус персональных данных. | +| public | [getType()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_getType) | | Возвращает тип персональных данных. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setCancellationDetails()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setCancellationDetails) | | Устанавливает cancellation_details. | +| public | [setCreatedAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setCreatedAt) | | Устанавливает время создания персональных данных. | +| public | [setExpiresAt()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setExpiresAt) | | Устанавливает срок жизни объекта персональных данных. | +| public | [setId()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setId) | | Устанавливает id. | +| public | [setMetadata()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setMetadata) | | Устанавливает любые дополнительные данные. | +| public | [setStatus()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setStatus) | | Устанавливает статус персональных данных. | +| public | [setType()](../classes/YooKassa-Model-PersonalData-PersonalData.md#method_setType) | | Устанавливает тип персональных данных. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/PersonalData/PersonalDataResponse.php](../../lib/Request/PersonalData/PersonalDataResponse.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + * \YooKassa\Request\PersonalData\PersonalDataResponse + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $cancellation_details : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails +--- +***Description*** + +Комментарий к отмене выплаты + +**Type:** PersonalDataCancellationDetails + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $cancellationDetails : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails +--- +***Description*** + +Комментарий к отмене выплаты + +**Type:** PersonalDataCancellationDetails + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания персональных данных + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания персональных данных + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $expires_at : \DateTime|null +--- +***Description*** + +Срок жизни объекта персональных данных + +**Type:** DateTime|null + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $expiresAt : \DateTime|null +--- +***Description*** + +Срок жизни объекта персональных данных + +**Type:** DateTime|null + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор персональных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные выплаты указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $status : string +--- +***Description*** + +Текущий статус персональных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +#### public $type : string +--- +***Description*** + +Тип персональных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null + +```php +public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null +``` + +**Summary** + +Возвращает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null - + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает created_at. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \DateTime - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает срок жизни объекта персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** \DateTime|null - Срок жизни объекта персональных данных + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - + + + +#### public getMetadata() : array|null + +```php +public getMetadata() : array|null +``` + +**Summary** + +Возвращает любые дополнительные данные. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** array|null - Любые дополнительные данные + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - Статус персональных данных + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +**Returns:** string - Тип персональных данных + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : $this + +```php +public setCancellationDetails(\YooKassa\Model\PersonalData\PersonalDataCancellationDetails|array|null $cancellation_details) : $this +``` + +**Summary** + +Устанавливает cancellation_details. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PersonalData\PersonalDataCancellationDetails OR array OR null | cancellation_details | | + +**Returns:** $this - + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания персональных данных | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** $this - + + + +#### public setExpiresAt() : $this + +```php +public setExpiresAt(\DateTime|string|int|null $expires_at = null) : $this +``` + +**Summary** + +Устанавливает срок жизни объекта персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | expires_at | Срок жизни объекта персональных данных | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** $this - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает id. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор персональных данных, сохраненных в ЮKassa. | + +**Returns:** $this - + + + +#### public setMetadata() : $this + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this +``` + +**Summary** + +Устанавливает любые дополнительные данные. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | metadata | Любые дополнительные данные | + +**Returns:** $this - + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус персональных данных | + +**Returns:** $this - + + + +#### public setType() : $this + +```php +public setType(string $type) : $this +``` + +**Summary** + +Устанавливает тип персональных данных. + +**Details:** +* Inherited From: [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип персональных данных | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md index 43ae30ae..26f6f70a 100644 --- a/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md +++ b/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md @@ -71,12 +71,12 @@ Class AbstractReceipt | public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | | public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | | public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | | public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | | public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | @@ -127,7 +127,7 @@ LENGTH_RECEIPT_ID = 39 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** @@ -139,7 +139,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального документа. -**Type:** string +**Type:** string **Details:** @@ -151,7 +151,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** @@ -163,7 +163,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** @@ -175,7 +175,7 @@ LENGTH_RECEIPT_ID = 39 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** @@ -187,7 +187,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального документа. -**Type:** string +**Type:** string **Details:** @@ -199,7 +199,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** @@ -211,7 +211,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** @@ -223,7 +223,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в ЮKassa. -**Type:** string +**Type:** string **Details:** @@ -235,7 +235,7 @@ LENGTH_RECEIPT_ID = 39 Список товаров в заказе. -**Type:** ReceiptResponseItemInterface[] +**Type:** ReceiptResponseItemInterface[] **Details:** @@ -247,7 +247,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** @@ -259,7 +259,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** @@ -271,7 +271,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** @@ -283,7 +283,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** @@ -295,7 +295,7 @@ LENGTH_RECEIPT_ID = 39 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -307,7 +307,7 @@ LENGTH_RECEIPT_ID = 39 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** @@ -319,7 +319,7 @@ LENGTH_RECEIPT_ID = 39 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -331,7 +331,7 @@ LENGTH_RECEIPT_ID = 39 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** @@ -367,7 +367,7 @@ LENGTH_RECEIPT_ID = 39 Перечень совершенных расчетов. -**Type:** SettlementInterface[] +**Type:** SettlementInterface[] **Details:** @@ -379,7 +379,7 @@ LENGTH_RECEIPT_ID = 39 Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). -**Type:** string +**Type:** string **Details:** @@ -391,7 +391,7 @@ LENGTH_RECEIPT_ID = 39 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** @@ -403,7 +403,7 @@ LENGTH_RECEIPT_ID = 39 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** @@ -415,7 +415,7 @@ LENGTH_RECEIPT_ID = 39 Тип чека в онлайн-кассе: приход "payment" или возврат "refund". -**Type:** string +**Type:** string **Details:** @@ -885,20 +885,16 @@ public getType() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -919,92 +915,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1456,11 +1436,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md index ee9ee21a..84301e31 100644 --- a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md @@ -10,65 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 91 56 Пример использования билдера ```php -try { - $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder(); - $receiptBuilder->setType(\YooKassa\Model\ReceiptType::PAYMENT) - ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f', \YooKassa\Model\ReceiptType::PAYMENT) // payment_id - ->setCustomer(array( - 'email' => 'john.doe@merchant.com', - 'phone' => '71111111111', - )) - ->setItems(array( - array( - 'description' => 'Платок Gucci', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3000.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ), - )) - ->setSettlements(array( - array( - 'type' => 'prepayment', - 'amount' => array( - 'value' => 100.00, - 'currency' => 'RUB', - ), - ), - )) - ->setSend(true); - - // Создаем объект запроса - $request = $receiptBuilder->build(); - - // Можно изменить данные, если нужно - $request->setOnBehalfOf('159753'); - $request->addItem(new \YooKassa\Model\ReceiptItem(array( - 'description' => 'Платок Gucci Новый', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3500.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ))); - - $idempotenceKey = uniqid('', true); - $response = $client->createReceipt($request, $idempotenceKey); -} catch (Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -104,12 +48,12 @@ var_dump($response); | public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | | public | [getType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getType) | | Возвращает тип чека в онлайн-кассе | | public | [hasCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_hasCustomer) | | Проверяет наличие данных о плательщике | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция товаров и оплат | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAdditionalUserProps()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setAdditionalUserProps) | | Устанавливает дополнительный реквизит пользователя | | public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setCustomer) | | Устанавливает информацию о плательщике | | public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setItems) | | Устанавливает список позиций в чеке | @@ -595,20 +539,16 @@ public hasCustomer() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -629,99 +569,83 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - -#### public setAdditionalUserProps() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setAdditionalUserProps() : void|\YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array $value) : void|\YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -736,14 +660,14 @@ public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array | ---- | ---- | ----------- | | \YooKassa\Model\Receipt\AdditionalUserProps OR array | value | Дополнительный реквизит пользователя | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** void|\YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setCustomer(\YooKassa\Model\ReceiptCustomerInterface|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setCustomer(\YooKassa\Model\ReceiptCustomerInterface|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -758,7 +682,7 @@ public setCustomer(\YooKassa\Model\ReceiptCustomerInterface|array $value) : \Yoo | ---- | ---- | ----------- | | \YooKassa\Model\ReceiptCustomerInterface OR array | value | Информация о плательщике | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - @@ -796,10 +720,10 @@ ReceiptItemInterface, в противном случае будет выброш -#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setObjectId(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setObjectId(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -814,14 +738,14 @@ public setObjectId(string $value) : \YooKassa\Request\Receipts\CreatePostReceipt | ---- | ---- | ----------- | | string | value | Id объекта чека | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setObjectType() : mixed +#### public setObjectType() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setObjectType(string $value) : mixed +public setObjectType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -836,14 +760,14 @@ public setObjectType(string $value) : mixed | ---- | ---- | ----------- | | string | value | Тип объекта чека | -**Returns:** mixed - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setOnBehalfOf() : mixed +#### public setOnBehalfOf() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setOnBehalfOf(string $value) : mixed +public setOnBehalfOf(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -863,14 +787,14 @@ public setOnBehalfOf(string $value) : mixed | ---- | ---- | ----------- | | string | value | | -**Returns:** mixed - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setReceiptIndustryDetails() : mixed +#### public setReceiptIndustryDetails() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[] $value) : mixed +public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -883,21 +807,16 @@ public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[] ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| array OR \YooKassa\Model\Receipt\IndustryDetails[] | value | Отраслевой реквизит чека | +| array OR \YooKassa\Model\Receipt\IndustryDetails | value | Отраслевой реквизит чека | -##### Throws: -| Type | Description | -| ---- | ----------- | -| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не массив | - -**Returns:** mixed - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setReceiptOperationalDetails() : mixed +#### public setReceiptOperationalDetails() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails $value) : mixed +public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -912,19 +831,14 @@ public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDet | ---- | ---- | ----------- | | array OR \YooKassa\Model\Receipt\OperationalDetails | value | Операционный реквизит чека | -##### Throws: -| Type | Description | -| ---- | ----------- | -| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не массив | - -**Returns:** mixed - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setSend(bool $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setSend(bool $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -939,14 +853,14 @@ public setSend(bool $value) : \YooKassa\Request\Receipts\CreatePostReceiptReques | ---- | ---- | ----------- | | bool | value | Признак отложенной отправки чека. | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - -#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setSettlements(\YooKassa\Model\SettlementInterface[]|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setSettlements(\YooKassa\Model\SettlementInterface|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -959,9 +873,9 @@ public setSettlements(\YooKassa\Model\SettlementInterface[]|array $value) : \Yoo ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| \YooKassa\Model\SettlementInterface[] OR array | value | Массив оплат, обеспечивающих выдачу товара. | +| \YooKassa\Model\SettlementInterface OR array | value | Массив оплат, обеспечивающих выдачу товара. | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - @@ -993,10 +907,10 @@ public setTaxSystemCode(int $value) : \YooKassa\Request\Receipts\CreatePostRecei -#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequest ```php -public setType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +public setType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest ``` **Summary** @@ -1011,7 +925,7 @@ public setType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequ | ---- | ---- | ----------- | | string | value | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | -**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - @@ -1099,11 +1013,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md index 95b0c8e2..02ed771f 100644 --- a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md @@ -10,65 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 91 56 Пример использования билдера ```php -try { - $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder(); - $receiptBuilder->setType(\YooKassa\Model\ReceiptType::PAYMENT) - ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f', \YooKassa\Model\ReceiptType::PAYMENT) // payment_id - ->setCustomer(array( - 'email' => 'john.doe@merchant.com', - 'phone' => '71111111111', - )) - ->setItems(array( - array( - 'description' => 'Платок Gucci', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3000.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ), - )) - ->setSettlements(array( - array( - 'type' => 'prepayment', - 'amount' => array( - 'value' => 100.00, - 'currency' => 'RUB', - ), - ), - )) - ->setSend(true); - - // Создаем объект запроса - $request = $receiptBuilder->build(); - - // Можно изменить данные, если нужно - $request->setOnBehalfOf('159753'); - $request->addItem(new \YooKassa\Model\ReceiptItem(array( - 'description' => 'Платок Gucci Новый', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3500.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ))); - - $idempotenceKey = uniqid('', true); - $response = $client->createReceipt($request, $idempotenceKey); -} catch (Exception $e) { - $response = $e; -} - -var_dump($response); ``` @@ -125,7 +69,7 @@ var_dump($response); Сумма чека -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -137,7 +81,7 @@ var_dump($response); Собираемый объект запроса -**Type:** CreatePostReceiptRequest +**Type:** CreatePostReceiptRequest **Details:** @@ -149,7 +93,7 @@ var_dump($response); Информация о плательщике -**Type:** ReceiptCustomer +**Type:** ReceiptCustomer **Details:** @@ -593,11 +537,11 @@ protected initCurrentObject() : \YooKassa\Request\Receipts\CreatePostReceiptRequ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md index d6b4b553..f2436205 100644 --- a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md @@ -20,6 +20,7 @@ Interface CreateReceiptRequestInterface | public | [getCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getCustomer) | | Возвращает информацию о плательщике. | | public | [getItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getItems) | | Возвращает список товаров в заказе | | public | [getObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getObjectId) | | Возвращает идентификатор объекта, для которого формируется чек | +| public | [getObjectType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getObjectType) | | Возвращает тип объекта чека | | public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | | public | [getReceiptIndustryDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getReceiptIndustryDetails) | | Возвращает отраслевой реквизит чека | | public | [getReceiptOperationalDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getReceiptOperationalDetails) | | Возвращает операционный реквизит чека | @@ -32,6 +33,7 @@ Interface CreateReceiptRequestInterface | public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setCustomer) | | Устанавливает информацию о пользователе | | public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setItems) | | Устанавливает список товаров чека | | public | [setObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setObjectId) | | Устанавливает идентификатор объекта, для которого формируется чек | +| public | [setObjectType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setObjectType) | | Устанавливает тип объекта чека | | public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setOnBehalfOf) | | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. | | public | [setReceiptIndustryDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setReceiptIndustryDetails) | | Устанавливает отраслевой реквизит чека | | public | [setReceiptOperationalDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setReceiptOperationalDetails) | | Устанавливает операционный реквизит чека | @@ -145,6 +147,45 @@ public setType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequ **Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + +#### public getObjectType() : string + +```php +public getObjectType() : string +``` + +**Summary** + +Возвращает тип объекта чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** string - Тип объекта чека + + + +#### public setObjectType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setObjectType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает тип объекта чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + #### public getSend() : mixed @@ -572,11 +613,11 @@ public notEmpty() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md index 973a5598..eeb49eca 100644 --- a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface $r ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md index 1eacd2d1..d69fec20 100644 --- a/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md +++ b/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md @@ -75,12 +75,12 @@ | public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | | public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | | public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | | public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | | public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | @@ -142,7 +142,7 @@ LENGTH_PAYMENT_ID = 36 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -155,7 +155,7 @@ LENGTH_PAYMENT_ID = 36 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -168,7 +168,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -181,7 +181,7 @@ LENGTH_PAYMENT_ID = 36 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -194,7 +194,7 @@ LENGTH_PAYMENT_ID = 36 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -207,7 +207,7 @@ LENGTH_PAYMENT_ID = 36 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -220,7 +220,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -233,7 +233,7 @@ LENGTH_PAYMENT_ID = 36 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -246,7 +246,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор чека в ЮKassa. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -259,7 +259,7 @@ LENGTH_PAYMENT_ID = 36 Список товаров в заказе. -**Type:** ReceiptResponseItemInterface[] +**Type:** ReceiptResponseItemInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -272,7 +272,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -285,7 +285,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -298,7 +298,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -311,7 +311,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -324,7 +324,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор платежа в ЮKassa -**Type:** string +**Type:** string **Details:** @@ -336,7 +336,7 @@ LENGTH_PAYMENT_ID = 36 Идентификатор платежа в ЮKassa -**Type:** string +**Type:** string **Details:** @@ -348,7 +348,7 @@ LENGTH_PAYMENT_ID = 36 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -361,7 +361,7 @@ LENGTH_PAYMENT_ID = 36 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -374,7 +374,7 @@ LENGTH_PAYMENT_ID = 36 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -387,7 +387,7 @@ LENGTH_PAYMENT_ID = 36 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -426,7 +426,7 @@ LENGTH_PAYMENT_ID = 36 Перечень совершенных расчетов. -**Type:** SettlementInterface[] +**Type:** SettlementInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -439,7 +439,7 @@ LENGTH_PAYMENT_ID = 36 Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -452,7 +452,7 @@ LENGTH_PAYMENT_ID = 36 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -465,7 +465,7 @@ LENGTH_PAYMENT_ID = 36 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -478,7 +478,7 @@ LENGTH_PAYMENT_ID = 36 Тип чека в онлайн-кассе: приход "payment" или возврат "refund". -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -961,20 +961,16 @@ public getType() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -995,92 +991,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1560,11 +1540,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md index 1735a5ed..06438657 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md @@ -60,11 +60,11 @@ public factory(array $data) : \YooKassa\Request\Receipts\AbstractReceiptResponse ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md index 8a2bf8cb..89f92d11 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md @@ -209,11 +209,11 @@ public notEmpty() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md index 1e46e9c8..d5da36c2 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md @@ -78,11 +78,11 @@ | public | [getQuantity()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getQuantity) | | Возвращает количество товара | | public | [getSupplier()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getSupplier) | | Возвращает информацию о поставщике товара или услуги | | public | [getVatCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getVatCode) | | Возвращает ставку НДС | -| public | [jsonSerialize()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAgentType()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setAgentType) | | Устанавливает тип посредника, реализующего товар или услугу | | public | [setCountryOfOriginCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setCountryOfOriginCode) | | Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира | | public | [setCustomsDeclarationNumber()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setCustomsDeclarationNumber) | | Устанавливает номер таможенной декларации (от 1 до 32 символов) | @@ -146,7 +146,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Тип посредника, реализующего товар или услугу -**Type:** string +**Type:** string **Details:** @@ -158,7 +158,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Тип посредника, реализующего товар или услугу -**Type:** string +**Type:** string **Details:** @@ -170,7 +170,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Суммарная стоимость покупаемого товара в копейках/центах -**Type:** float +**Type:** float **Details:** @@ -182,7 +182,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код страны происхождения товара (тег в 54 ФЗ — 1230) -**Type:** string +**Type:** string **Details:** @@ -194,7 +194,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код страны происхождения товара (тег в 54 ФЗ — 1230) -**Type:** string +**Type:** string **Details:** @@ -206,7 +206,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 -**Type:** string +**Type:** string **Details:** @@ -218,7 +218,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 -**Type:** string +**Type:** string **Details:** @@ -230,7 +230,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Наименование товара (тег в 54 ФЗ — 1030) -**Type:** string +**Type:** string **Details:** @@ -242,7 +242,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229) -**Type:** float +**Type:** float **Details:** @@ -254,7 +254,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код товара (тег в 54 ФЗ — 1163) -**Type:** MarkCodeInfo +**Type:** MarkCodeInfo **Details:** @@ -266,7 +266,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Режим обработки кода маркировки (тег в 54 ФЗ — 2102) -**Type:** string +**Type:** string **Details:** @@ -278,7 +278,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Дробное количество маркированного товара (тег в 54 ФЗ — 1291) -**Type:** MarkQuantity +**Type:** MarkQuantity **Details:** @@ -290,7 +290,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код товара (тег в 54 ФЗ — 1163) -**Type:** MarkCodeInfo +**Type:** MarkCodeInfo **Details:** @@ -302,7 +302,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Режим обработки кода маркировки (тег в 54 ФЗ — 2102) -**Type:** string +**Type:** string **Details:** @@ -314,7 +314,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Дробное количество маркированного товара (тег в 54 ФЗ — 1291) -**Type:** MarkQuantity +**Type:** MarkQuantity **Details:** @@ -326,7 +326,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Мера количества предмета расчета (тег в 54 ФЗ — 2108) -**Type:** string +**Type:** string **Details:** @@ -338,7 +338,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Признак способа расчета (тег в 54 ФЗ — 1214) -**Type:** string +**Type:** string **Details:** @@ -350,7 +350,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Признак предмета расчета (тег в 54 ФЗ — 1212) -**Type:** string +**Type:** string **Details:** @@ -362,7 +362,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -374,7 +374,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Признак способа расчета (тег в 54 ФЗ — 1214) -**Type:** string +**Type:** string **Details:** @@ -386,7 +386,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Признак предмета расчета (тег в 54 ФЗ — 1212) -**Type:** string +**Type:** string **Details:** @@ -398,7 +398,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** @@ -410,7 +410,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Цена товара (тег в 54 ФЗ — 1079) -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -422,7 +422,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код товара — уникальный номер, который присваивается экземпляру товара при маркировке (тег в 54 ФЗ — 1162) -**Type:** string +**Type:** string **Details:** @@ -434,7 +434,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Код товара — уникальный номер, который присваивается экземпляру товара при маркировке (тег в 54 ФЗ — 1162) -**Type:** string +**Type:** string **Details:** @@ -446,7 +446,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Количество (тег в 54 ФЗ — 1023) -**Type:** float +**Type:** float **Details:** @@ -458,7 +458,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224) -**Type:** Supplier +**Type:** Supplier **Details:** @@ -470,7 +470,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Ставка НДС, число 1-6 (тег в 54 ФЗ — 1199) -**Type:** int +**Type:** int **Details:** @@ -482,7 +482,7 @@ MAX_PRODUCT_CODE_LENGTH = 96 : int Ставка НДС, число 1-6 (тег в 54 ФЗ — 1199) -**Type:** int +**Type:** int **Details:** @@ -936,10 +936,6 @@ public getVatCode() : int|null public jsonSerialize() : array ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) @@ -951,92 +947,76 @@ public jsonSerialize() : array | inheritdoc | | | -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1508,11 +1488,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md index ec606700..296ab74d 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md @@ -107,10 +107,10 @@ public getQuantity() : float -#### public getAmount() : float +#### public getAmount() : int ```php -public getAmount() : float +public getAmount() : int ``` **Summary** @@ -120,7 +120,7 @@ public getAmount() : float **Details:** * Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) -**Returns:** float - Сумма стоимости покупаемого товара +**Returns:** int - Сумма стоимости покупаемого товара @@ -373,11 +373,11 @@ public getSupplier() : \YooKassa\Model\SupplierInterface ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md index 7bb40148..cdd6ffd6 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md @@ -59,11 +59,11 @@ | public | [hasPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | | public | [hasRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasRefundId) | | Проверяет, был ли установлен идентификатор возврата | | public | [hasStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasStatus) | | Проверяет, был ли установлен статус выбираемых возвратов | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются возвраты | | public | [setCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются возвраты | | public | [setCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются возвраты | @@ -158,7 +158,7 @@ MAX_LIMIT_VALUE = 100 Токен для получения следующей страницы выборки -**Type:** string +**Type:** string **Details:** @@ -170,7 +170,7 @@ MAX_LIMIT_VALUE = 100 Ограничение количества объектов возврата, отображаемых на одной странице выдачи -**Type:** int|null +**Type:** int|null **Details:** @@ -182,7 +182,7 @@ MAX_LIMIT_VALUE = 100 Идентификатор платежа -**Type:** string +**Type:** string **Details:** @@ -194,7 +194,7 @@ MAX_LIMIT_VALUE = 100 Идентификатор возврата -**Type:** string +**Type:** string **Details:** @@ -206,7 +206,7 @@ MAX_LIMIT_VALUE = 100 Статус возврата -**Type:** string +**Type:** string **Details:** @@ -705,109 +705,89 @@ public hasStatus() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1139,11 +1119,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md index e44e0e50..d41fa008 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md @@ -53,7 +53,7 @@ Инстанс собираемого запроса -**Type:** ReceiptsRequest +**Type:** ReceiptsRequest Инстанс собираемого объекта запроса **Details:** @@ -406,11 +406,11 @@ protected initCurrentObject() : \YooKassa\Request\Receipts\ReceiptsRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md index 5e640ef6..9ff1fc99 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md @@ -373,11 +373,11 @@ public hasLimit() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md index 0f385735..4595ad4b 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Receipts\ReceiptsRequestInterface $request) : ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md index 5f6ee3f4..bbd0e8f2 100644 --- a/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md @@ -137,11 +137,11 @@ public hasNextCursor() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md index 6e7298a0..e4b74a59 100644 --- a/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md +++ b/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md @@ -75,12 +75,12 @@ | public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | | public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | | public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | | public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | | public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | @@ -142,7 +142,7 @@ LENGTH_REFUND_ID = 36 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -155,7 +155,7 @@ LENGTH_REFUND_ID = 36 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -168,7 +168,7 @@ LENGTH_REFUND_ID = 36 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -181,7 +181,7 @@ LENGTH_REFUND_ID = 36 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -194,7 +194,7 @@ LENGTH_REFUND_ID = 36 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -207,7 +207,7 @@ LENGTH_REFUND_ID = 36 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -220,7 +220,7 @@ LENGTH_REFUND_ID = 36 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -233,7 +233,7 @@ LENGTH_REFUND_ID = 36 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -246,7 +246,7 @@ LENGTH_REFUND_ID = 36 Идентификатор чека в ЮKassa. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -259,7 +259,7 @@ LENGTH_REFUND_ID = 36 Список товаров в заказе. -**Type:** ReceiptResponseItemInterface[] +**Type:** ReceiptResponseItemInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -272,7 +272,7 @@ LENGTH_REFUND_ID = 36 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -285,7 +285,7 @@ LENGTH_REFUND_ID = 36 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -298,7 +298,7 @@ LENGTH_REFUND_ID = 36 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -311,7 +311,7 @@ LENGTH_REFUND_ID = 36 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -324,7 +324,7 @@ LENGTH_REFUND_ID = 36 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -337,7 +337,7 @@ LENGTH_REFUND_ID = 36 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -350,7 +350,7 @@ LENGTH_REFUND_ID = 36 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -363,7 +363,7 @@ LENGTH_REFUND_ID = 36 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -376,7 +376,7 @@ LENGTH_REFUND_ID = 36 Идентификатор возврата в ЮKassa. -**Type:** string +**Type:** string **Details:** @@ -388,7 +388,7 @@ LENGTH_REFUND_ID = 36 Идентификатор возврата в ЮKassa. -**Type:** string +**Type:** string **Details:** @@ -426,7 +426,7 @@ LENGTH_REFUND_ID = 36 Перечень совершенных расчетов. -**Type:** SettlementInterface[] +**Type:** SettlementInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -439,7 +439,7 @@ LENGTH_REFUND_ID = 36 Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -452,7 +452,7 @@ LENGTH_REFUND_ID = 36 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -465,7 +465,7 @@ LENGTH_REFUND_ID = 36 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -478,7 +478,7 @@ LENGTH_REFUND_ID = 36 Тип чека в онлайн-кассе: приход "payment" или возврат "refund". -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -961,20 +961,16 @@ public getType() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -995,92 +991,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1560,11 +1540,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md index ca13620b..cc743819 100644 --- a/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md +++ b/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md @@ -71,12 +71,12 @@ | public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | | public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | | public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | | public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | | public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | @@ -128,7 +128,7 @@ LENGTH_RECEIPT_ID = 39 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -141,7 +141,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -154,7 +154,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -167,7 +167,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -180,7 +180,7 @@ LENGTH_RECEIPT_ID = 39 Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -193,7 +193,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального документа. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -206,7 +206,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -219,7 +219,7 @@ LENGTH_RECEIPT_ID = 39 Номер фискального накопителя в кассовом аппарате. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -232,7 +232,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор чека в ЮKassa. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -245,7 +245,7 @@ LENGTH_RECEIPT_ID = 39 Список товаров в заказе. -**Type:** ReceiptResponseItemInterface[] +**Type:** ReceiptResponseItemInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -258,7 +258,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -271,7 +271,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор объекта чека. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -284,7 +284,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -297,7 +297,7 @@ LENGTH_RECEIPT_ID = 39 Идентификатор магазина. -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -310,7 +310,7 @@ LENGTH_RECEIPT_ID = 39 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -323,7 +323,7 @@ LENGTH_RECEIPT_ID = 39 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -336,7 +336,7 @@ LENGTH_RECEIPT_ID = 39 Отраслевой реквизит чека. -**Type:** IndustryDetails[] +**Type:** IndustryDetails[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -349,7 +349,7 @@ LENGTH_RECEIPT_ID = 39 Операционный реквизит чека. -**Type:** OperationalDetails +**Type:** OperationalDetails **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -388,7 +388,7 @@ LENGTH_RECEIPT_ID = 39 Перечень совершенных расчетов. -**Type:** SettlementInterface[] +**Type:** SettlementInterface[] **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -401,7 +401,7 @@ LENGTH_RECEIPT_ID = 39 Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -414,7 +414,7 @@ LENGTH_RECEIPT_ID = 39 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -427,7 +427,7 @@ LENGTH_RECEIPT_ID = 39 Код системы налогообложения. Число 1-6. -**Type:** int +**Type:** int **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -440,7 +440,7 @@ LENGTH_RECEIPT_ID = 39 Тип чека в онлайн-кассе: приход "payment" или возврат "refund". -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) @@ -906,20 +906,16 @@ public getType() : string | inheritdoc | | | -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - @@ -940,92 +936,76 @@ public notEmpty() : bool -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1477,11 +1457,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md b/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md index 7d6729b4..ea55e94e 100644 --- a/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md +++ b/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md @@ -48,11 +48,11 @@ | public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | *deprecated* | | | public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | | public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | | public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | | public | [setDeal()](../classes/YooKassa-Model-Refund.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат. | @@ -84,7 +84,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -123,7 +123,7 @@ Данные о сделке, в составе которой проходит возврат -**Type:** RefundDealInfo +**Type:** RefundDealInfo **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -136,7 +136,7 @@ Комментарий, основание для возврата средств покупателю -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -149,7 +149,7 @@ Идентификатор возврата платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -162,7 +162,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -175,7 +175,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -188,7 +188,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -201,7 +201,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -214,7 +214,7 @@ Статус возврата -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -534,109 +534,89 @@ public getStatus() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -954,11 +934,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md index 7fd29499..4b11a936 100644 --- a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md @@ -10,44 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 148 35 Пример использования билдера ```php -// Создание запроса возврата через билдер -try { - $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder(); - $refundBuilder - ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f') - ->setAmount(3500.00) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setDescription('Не подошел цвет') - ->setReceiptItems(array( - array( - 'description' => 'Платок Gucci', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3000.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ), - )) - ->setReceiptEmail('john.doe@merchant.com') - ->setTaxSystemCode(1); - - // Создаем объект запроса - $request = $refundBuilder->build(); - - // Можно изменить данные, если нужно - $request->setDescription('Не подошел цвет и размер'); - - $idempotenceKey = uniqid('', true); - $response = $client->createRefund($request, $idempotenceKey); -} catch (Exception $e) { - $response = $e; -} ``` @@ -93,11 +58,11 @@ try { | public | [hasPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasPaymentId) | | Проверяет, был ли установлена идентификатор платежа | | public | [hasReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasReceipt) | | Проверяет наличие чека | | public | [hasSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasSources) | | Проверяет наличие информации о распределении денег | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [removeReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_removeReceipt) | | Удаляет чек из запроса | | public | [setAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setAmount) | | Устанавливает сумму | | public | [setDeal()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат | @@ -113,7 +78,7 @@ try { --- ### Details * File: [lib/Request/Refunds/CreateRefundRequest.php](../../lib/Request/Refunds/CreateRefundRequest.php) -* Package: Default +* Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) @@ -131,7 +96,7 @@ try { Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** @@ -143,7 +108,7 @@ try { Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) @@ -156,7 +121,7 @@ try { Информация о сделке -**Type:** RefundDealData|null +**Type:** RefundDealData|null **Details:** @@ -168,7 +133,7 @@ try { Комментарий к операции возврата, основание для возврата средств покупателю. -**Type:** string +**Type:** string **Details:** @@ -180,7 +145,7 @@ try { Айди платежа для которого создаётся возврат -**Type:** string +**Type:** string **Details:** @@ -192,7 +157,7 @@ try { Идентификатор платежа для которого создаётся возврат -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) @@ -205,7 +170,7 @@ try { Инстанс чека или null -**Type:** ReceiptInterface|null +**Type:** ReceiptInterface|null **Details:** @@ -217,7 +182,7 @@ try { Информация о распределении денег — сколько и в какой магазин нужно перевести -**Type:** SourceInterface[]|null +**Type:** SourceInterface[]|null **Details:** @@ -614,109 +579,89 @@ public hasSources() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -975,11 +920,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md index 403fe2ef..de2be57d 100644 --- a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md @@ -10,44 +10,9 @@ --- ### Examples -Пример использования билдера +02-builder.php 148 35 Пример использования билдера ```php -// Создание запроса возврата через билдер -try { - $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder(); - $refundBuilder - ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f') - ->setAmount(3500.00) - ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) - ->setDescription('Не подошел цвет') - ->setReceiptItems(array( - array( - 'description' => 'Платок Gucci', - 'quantity' => '1.00', - 'amount' => array( - 'value' => '3000.00', - 'currency' => 'RUB', - ), - 'vat_code' => 2, - 'payment_mode' => 'full_payment', - 'payment_subject' => 'commodity', - ), - )) - ->setReceiptEmail('john.doe@merchant.com') - ->setTaxSystemCode(1); - - // Создаем объект запроса - $request = $refundBuilder->build(); - - // Можно изменить данные, если нужно - $request->setDescription('Не подошел цвет и размер'); - - $idempotenceKey = uniqid('', true); - $response = $client->createRefund($request, $idempotenceKey); -} catch (Exception $e) { - $response = $e; -} ``` @@ -106,7 +71,7 @@ try { Сумма -**Type:** MonetaryAmount +**Type:** MonetaryAmount **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -119,7 +84,7 @@ try { Собираемый объект запроса к API -**Type:** CreateRefundRequest +**Type:** CreateRefundRequest **Details:** @@ -131,7 +96,7 @@ try { Объект с информацией о сделке, в составе которой проходит возврат. -**Type:** RefundDealData +**Type:** RefundDealData **Details:** @@ -143,7 +108,7 @@ try { Объект с информацией о чеке -**Type:** Receipt +**Type:** Receipt **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -156,7 +121,7 @@ try { Массив платежей в пользу разных мерчантов -**Type:** TransferInterface[] +**Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) @@ -619,11 +584,11 @@ protected initCurrentObject() : \YooKassa\Request\Refunds\CreateRefundRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md index 1fbc3484..f5de7751 100644 --- a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md @@ -334,11 +334,11 @@ public hasDeal() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md index 41238f67..32ba1dad 100644 --- a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Refunds\CreateRefundRequestInterface $request ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md index c1ed7301..39cb0b8c 100644 --- a/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md @@ -48,11 +48,11 @@ | public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | *deprecated* | | | public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | | public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | | public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | | public | [setDeal()](../classes/YooKassa-Model-Refund.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат. | @@ -85,7 +85,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -124,7 +124,7 @@ Данные о сделке, в составе которой проходит возврат -**Type:** RefundDealInfo +**Type:** RefundDealInfo **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -137,7 +137,7 @@ Комментарий, основание для возврата средств покупателю -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -150,7 +150,7 @@ Идентификатор возврата платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -163,7 +163,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -176,7 +176,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -189,7 +189,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -202,7 +202,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -215,7 +215,7 @@ Статус возврата -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -530,109 +530,89 @@ public getStatus() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -950,11 +930,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundResponse.md b/docs/classes/YooKassa-Request-Refunds-RefundResponse.md index 68df6ac4..65a86bc1 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundResponse.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundResponse.md @@ -48,11 +48,11 @@ | public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | *deprecated* | | | public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | | public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | | public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | | public | [setDeal()](../classes/YooKassa-Model-Refund.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат. | @@ -85,7 +85,7 @@ Сумма возврата -**Type:** AmountInterface +**Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -124,7 +124,7 @@ Данные о сделке, в составе которой проходит возврат -**Type:** RefundDealInfo +**Type:** RefundDealInfo **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -137,7 +137,7 @@ Комментарий, основание для возврата средств покупателю -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -150,7 +150,7 @@ Идентификатор возврата платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -163,7 +163,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -176,7 +176,7 @@ Идентификатор платежа -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -189,7 +189,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -202,7 +202,7 @@ Статус регистрации чека -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -215,7 +215,7 @@ Статус возврата -**Type:** string +**Type:** string **Details:** * Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) @@ -530,109 +530,89 @@ public getStatus() : string -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -950,11 +930,11 @@ protected getUnknownProperties() : array ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md index a5771f97..773e6198 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md @@ -56,11 +56,11 @@ | public | [hasLimit()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasLimit) | | Проверяет, было ли установлено ограничение количества объектов платежа | | public | [hasPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | | public | [hasStatus()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasStatus) | | Проверяет, был ли установлен статус выбираемых возвратов | -| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | -| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | -| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | -| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | -| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [setCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются возвраты | | public | [setCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются возвраты | | public | [setCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются возвраты | @@ -154,7 +154,7 @@ MAX_LIMIT_VALUE = 100 Токен для получения следующей страницы выборки -**Type:** string +**Type:** string **Details:** @@ -166,7 +166,7 @@ MAX_LIMIT_VALUE = 100 Ограничение количества объектов возврата, отображаемых на одной странице выдачи -**Type:** int|null +**Type:** int|null **Details:** @@ -178,7 +178,7 @@ MAX_LIMIT_VALUE = 100 Идентификатор платежа -**Type:** string +**Type:** string **Details:** @@ -190,7 +190,7 @@ MAX_LIMIT_VALUE = 100 Статус возврата -**Type:** string +**Type:** string **Details:** @@ -655,109 +655,89 @@ public hasStatus() : bool -#### public jsonSerialize() : array +#### public jsonSerialize() : mixed ```php -public jsonSerialize() : array +public jsonSerialize() : mixed ``` -**Summary** - -Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) -**Returns:** array - Ассоциативный массив со свойствами текущего объекта +**Returns:** mixed - -#### public offsetExists() : bool +#### public offsetExists() : mixed ```php -public offsetExists(string $offset) : bool +public offsetExists(mixed $offset) : mixed ``` -**Summary** - -Проверяет наличие свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя проверяемого свойства | +| mixed | offset | | -**Returns:** bool - True если свойство имеется, false если нет +**Returns:** mixed - #### public offsetGet() : mixed ```php -public offsetGet(string $offset) : mixed +public offsetGet(mixed $offset) : mixed ``` -**Summary** - -Возвращает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | +| mixed | offset | | -**Returns:** mixed - Значение свойства +**Returns:** mixed - -#### public offsetSet() : void +#### public offsetSet() : mixed ```php -public offsetSet(string $offset, mixed $value) : void +public offsetSet(mixed $offset, mixed $value) : mixed ``` -**Summary** - -Устанавливает значение свойства - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя свойства | -| mixed | value | Значение свойства | +| mixed | offset | | +| mixed | value | | -**Returns:** void - +**Returns:** mixed - -#### public offsetUnset() : void +#### public offsetUnset() : mixed ```php -public offsetUnset(string $offset) : void +public offsetUnset(mixed $offset) : mixed ``` -**Summary** - -Удаляет свойство - **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | -| string | offset | Имя удаляемого свойства | +| mixed | offset | | -**Returns:** void - +**Returns:** mixed - @@ -1067,11 +1047,11 @@ protected setValidationError(string $value) : mixed ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md index 3ef95f37..9f89733a 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md @@ -52,7 +52,7 @@ Инстанс собираемого запроса -**Type:** RefundsRequest +**Type:** RefundsRequest Инстанс собираемого объекта запроса **Details:** @@ -377,11 +377,11 @@ protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequest ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md index 56c1eec2..dc8a19c1 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md @@ -300,11 +300,11 @@ public hasCursor() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md index 59e0bd9d..55106436 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md @@ -60,11 +60,11 @@ public serialize(\YooKassa\Request\Refunds\RefundsRequestInterface $request) : a ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md b/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md index 26d8f81f..ad488058 100644 --- a/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md +++ b/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md @@ -119,11 +119,11 @@ public hasNextCursor() : bool ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md new file mode 100644 index 00000000..6d5aab37 --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md @@ -0,0 +1,644 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequest +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedRequest. + +**Description:** + +Запрос на создание объекта самозанятого. + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#property_confirmation) | | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | +| public | [$itn](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#property_itn) | | ИНН самозанятого. | +| public | [$phone](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#property_phone) | | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_builder) | | Возвращает билдер объектов запросов создания платежа | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmation()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_getConfirmation) | | Возвращает сценарий подтверждения. | +| public | [getItn()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_getItn) | | Возвращает ИНН самозанятого | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getPhone()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_getPhone) | | Возвращает телефон самозанятого. | +| public | [hasConfirmation()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_hasConfirmation) | | Проверяет наличие сценария подтверждения самозанятого в запросе | +| public | [hasItn()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_hasItn) | | Проверяет наличие ИНН самозанятого в запросе | +| public | [hasPhone()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_hasPhone) | | Проверяет наличие телефона самозанятого в запросе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setConfirmation()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_setConfirmation) | | Устанавливает сценарий подтверждения. | +| public | [setItn()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_setItn) | | Устанавливает ИНН самозанятого | +| public | [setPhone()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_setPhone) | | Устанавливает телефон самозанятого. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md#method_validate) | | Проверяет на валидность текущий объект | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequest.php](../../lib/Request/SelfEmployed/SelfEmployedRequest.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\SelfEmployed\SelfEmployedRequest + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $confirmation : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null +--- +***Description*** + +Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. + +**Type:** SelfEmployedRequestConfirmation|null + +**Details:** + + + +#### public $itn : string|null +--- +***Description*** + +ИНН самозанятого. + +**Type:** string|null + +**Details:** + + + +#### public $phone : string|null +--- +***Description*** + +Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. + +**Type:** string|null + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder + +```php +Static public builder() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов запросов создания платежа + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder - Инстанс билдера объектов запросов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null + +```php +public getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null +``` + +**Summary** + +Возвращает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null - Сценарий подтверждения + + + +#### public getItn() : string|null + +```php +public getItn() : string|null +``` + +**Summary** + +Возвращает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** string|null - ИНН самозанятого + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getPhone() : string|null + +```php +public getPhone() : string|null +``` + +**Summary** + +Возвращает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** string|null - Телефон самозанятого + + + +#### public hasConfirmation() : bool + +```php +public hasConfirmation() : bool +``` + +**Summary** + +Проверяет наличие сценария подтверждения самозанятого в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** bool - True если сценарий подтверждения самозанятого задан, false если нет + + + +#### public hasItn() : bool + +```php +public hasItn() : bool +``` + +**Summary** + +Проверяет наличие ИНН самозанятого в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** bool - True если ИНН самозанятого задан, false если нет + + + +#### public hasPhone() : bool + +```php +public hasPhone() : bool +``` + +**Summary** + +Проверяет наличие телефона самозанятого в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** bool - True если телефон самозанятого задан, false если нет + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setConfirmation() : $this + +```php +public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this +``` + +**Summary** + +Устанавливает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null | confirmation | Сценарий подтверждения | + +**Returns:** $this - + + + +#### public setItn() : $this + +```php +public setItn(string|null $itn = null) : $this +``` + +**Summary** + +Устанавливает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | itn | ИНН самозанятого | + +**Returns:** $this - + + + +#### public setPhone() : $this + +```php +public setPhone(string|null $phone = null) : $this +``` + +**Summary** + +Устанавливает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | phone | Телефон самозанятого | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет на валидность текущий объект + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) + +**Returns:** bool - True если объект запроса валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string $value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md new file mode 100644 index 00000000..9455bd9b --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md @@ -0,0 +1,237 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс билдера объектов запросов к API на создание самозанятого + + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#method_build) | | Строит и возвращает объект запроса для отправки в API ЮKassa | +| public | [setConfirmation()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#method_setConfirmation) | | Устанавливает сценарий подтверждения. | +| public | [setItn()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#method_setItn) | | Устанавливает ИНН самозанятого | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPhone()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#method_setPhone) | | Устанавливает телефон самозанятого. | +| protected | [initCurrentObject()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php](../../lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| todo | | @example 02-builder.php 11 78 Пример использования билдера | + +--- +## Properties + +#### protected $currentObject : \YooKassa\Request\SelfEmployed\SelfEmployedRequest +--- +**Summary** + +Собираемый объект запроса + +**Type:** SelfEmployedRequest + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest + +```php +public build(array|null $options = null) : \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит и возвращает объект запроса для отправки в API ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив параметров для установки в объект запроса | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось | + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса + + + +#### public setConfirmation() : self + +```php +public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $value) : self +``` + +**Summary** + +Устанавливает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null | value | Сценарий подтверждения. | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setItn() : self + +```php +public setItn(string|null $value) : self +``` + +**Summary** + +Устанавливает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | ИНН самозанятого | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPhone() : self + +```php +public setPhone(string|null $value) : self +``` + +**Summary** + +Устанавливает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Телефон самозанятого. | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected initCurrentObject() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest + +```php +protected initCurrentObject() : \YooKassa\Request\SelfEmployed\SelfEmployedRequest +``` + +**Summary** + +Инициализирует объект запроса, который в дальнейшем будет собираться билдером + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequest - Инстанс собираемого объекта запроса к API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md new file mode 100644 index 00000000..3cae2273 --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md @@ -0,0 +1,362 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedRequestConfirmation. + + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md#method_getType) | | Возвращает тип сценария подтверждения | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md#method_setType) | | Устанавливает тип сценария подтверждения | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequestConfirmation.php](../../lib/Request/SelfEmployed/SelfEmployedRequestConfirmation.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md new file mode 100644 index 00000000..c86812ab --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md @@ -0,0 +1,94 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationFactory +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Class SelfEmployedRequestConfirmationFactory + + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md#method_factory) | | Возвращает объект, соответствующий типу подтверждения платежа | +| public | [factoryFromArray()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md#method_factoryFromArray) | | Возвращает объект, соответствующий типу подтверждения платежа, из массива данных | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequestConfirmationFactory.php](../../lib/Request/SelfEmployed/SelfEmployedRequestConfirmationFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationFactory + +--- +## Methods + +#### public factory() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation + +```php +public factory(string $type) : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationFactory](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation - + + + +#### public factoryFromArray() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation + +```php +public factoryFromArray(array $data, string|null $type = null) : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationFactory](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив данных подтверждения платежа | +| string OR null | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md new file mode 100644 index 00000000..bc97e39a --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md @@ -0,0 +1,357 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationRedirect +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployedConfirmationAttrsRedirect. + +**Description:** + +Перенаправление пользователя на сайт сервиса Мой налог для выдачи прав ЮMoney. + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md#method_getType) | | Возвращает тип сценария подтверждения | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md#method_setType) | | Устанавливает тип сценария подтверждения | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequestConfirmationRedirect.php](../../lib/Request/SelfEmployed/SelfEmployedRequestConfirmationRedirect.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) + * \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationRedirect + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationRedirect](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string $value) : mixed +``` + +**Summary** + +Устанавливает тип сценария подтверждения + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md new file mode 100644 index 00000000..d1676b76 --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md @@ -0,0 +1,70 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequestSerializer +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс сериалайзера объекта запроса к API на создание самозанятого + + +--- +### Constants +* No constants found + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md#method_serialize) | | Формирует ассоциативный массив данных из объекта запроса | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedRequestSerializer.php](../../lib/Request/SelfEmployed/SelfEmployedRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\SelfEmployed\SelfEmployedRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\SelfEmployed\SelfEmployedRequest $request) : array +``` + +**Summary** + +Формирует ассоциативный массив данных из объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\SelfEmployed\SelfEmployedRequestSerializer](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\SelfEmployed\SelfEmployedRequest | request | Объект запроса | + +**Returns:** array - Массив данных для дальнейшего кодирования в JSON + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedResponse.md b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedResponse.md new file mode 100644 index 00000000..881b98b3 --- /dev/null +++ b/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedResponse.md @@ -0,0 +1,739 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\SelfEmployed\SelfEmployedResponse +### Namespace: [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) +--- +**Summary:** + +Класс, представляющий модель SelfEmployed. + +**Description:** + +Информация о персональных данных + +--- +### Constants +* No constants found + +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_confirmation) | | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | +| public | [$created_at](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_created_at) | | Время создания объекта самозанятого. | +| public | [$createdAt](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_createdAt) | | Время создания объекта самозанятого. | +| public | [$id](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_id) | | Идентификатор самозанятого в ЮKassa. | +| public | [$itn](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_itn) | | ИНН самозанятого. | +| public | [$phone](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_phone) | | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | +| public | [$status](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_status) | | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | +| public | [$test](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#property_test) | | Признак тестовой операции. | + +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getConfirmation) | | Возвращает сценарий подтверждения. | +| public | [getCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getCreatedAt) | | Возвращает время создания объекта самозанятого | +| public | [getId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getId) | | Возвращает id. | +| public | [getItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getItn) | | Возвращает ИНН самозанятого | +| public | [getPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getPhone) | | Возвращает телефон самозанятого. | +| public | [getStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getStatus) | | Возвращает статус самозанятого. | +| public | [getTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_getTest) | | Возвращает признак тестовой операции. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | +| public | [setConfirmation()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setConfirmation) | | Устанавливает сценарий подтверждения. | +| public | [setCreatedAt()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setCreatedAt) | | Устанавливает время создания объекта самозанятого | +| public | [setId()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setId) | | Устанавливает идентификатор самозанятого. | +| public | [setItn()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setItn) | | Устанавливает ИНН самозанятого | +| public | [setPhone()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setPhone) | | Устанавливает телефон самозанятого. | +| public | [setStatus()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setStatus) | | Устанавливает статус самозанятого. | +| public | [setTest()](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md#method_setTest) | | Устанавливает признак тестовой операции. | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | + +--- +### Details +* File: [lib/Request/SelfEmployed/SelfEmployedResponse.php](../../lib/Request/SelfEmployed/SelfEmployedResponse.php) +* Package: YooKassa\Model +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + * \YooKassa\Request\SelfEmployed\SelfEmployedResponse + +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| author | | cms@yoomoney.ru | + +--- +## Properties + +#### public $confirmation : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null +--- +***Description*** + +Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. + +**Type:** SelfEmployedConfirmation|null + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания объекта самозанятого. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания объекта самозанятого. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор самозанятого в ЮKassa. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $itn : string|null +--- +***Description*** + +ИНН самозанятого. + +**Type:** string|null + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $phone : string|null +--- +***Description*** + +Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. + +**Type:** string|null + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $status : string +--- +***Description*** + +Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции. + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array $data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string $propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string $propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string $propertyName, mixed $value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string $propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable $sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null + +```php +public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null +``` + +**Summary** + +Возвращает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null - Сценарий подтверждения + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** \DateTime - Время создания объекта самозанятого + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает id. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string - + + + +#### public getItn() : string|null + +```php +public getItn() : string|null +``` + +**Summary** + +Возвращает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string|null - ИНН самозанятого + + + +#### public getPhone() : string|null + +```php +public getPhone() : string|null +``` + +**Summary** + +Возвращает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string|null - Телефон самозанятого + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** string - Статус самозанятого + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +**Returns:** bool - Признак тестовой операции. + + + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** mixed - + + + +#### public offsetExists() : mixed + +```php +public offsetExists(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetGet() : mixed + +```php +public offsetGet(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public offsetSet() : mixed + +```php +public offsetSet(mixed $offset, mixed $value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(mixed $offset) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | offset | | + +**Returns:** mixed - + + + +#### public setConfirmation() : $this + +```php +public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this +``` + +**Summary** + +Устанавливает сценарий подтверждения. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null | confirmation | Сценарий подтверждения | + +**Returns:** $this - + + + +#### public setCreatedAt() : $this + +```php +public setCreatedAt(\DateTime|string|int $created_at) : $this +``` + +**Summary** + +Устанавливает время создания объекта самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | created_at | Время создания объекта самозанятого | + +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** $this - + + + +#### public setId() : $this + +```php +public setId(string $id) : $this +``` + +**Summary** + +Устанавливает идентификатор самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | id | Идентификатор самозанятого в ЮKassa. | + +**Returns:** $this - + + + +#### public setItn() : $this + +```php +public setItn(string|null $itn = null) : $this +``` + +**Summary** + +Устанавливает ИНН самозанятого + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | itn | ИНН самозанятого | + +**Returns:** $this - + + + +#### public setPhone() : $this + +```php +public setPhone(string|null $phone = null) : $this +``` + +**Summary** + +Устанавливает телефон самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | phone | Телефон самозанятого | + +**Returns:** $this - + + + +#### public setStatus() : $this + +```php +public setStatus(string $status) : $this +``` + +**Summary** + +Устанавливает статус самозанятого. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | status | Статус самозанятого | + +**Returns:** $this - + + + +#### public setTest() : $this + +```php +public setTest(bool $test) : $this +``` + +**Summary** + +Устанавливает признак тестовой операции. + +**Details:** +* Inherited From: [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) + +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции. | + +**Returns:** $this - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md b/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md index ebc045d5..fe9931ed 100644 --- a/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md +++ b/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md @@ -96,11 +96,11 @@ public getType() : string ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/examples/06-payouts.md b/docs/examples/06-payouts.md new file mode 100644 index 00000000..4b2dafc6 --- /dev/null +++ b/docs/examples/06-payouts.md @@ -0,0 +1,102 @@ +## Работа с выплатами + +Выплата — это сумма денег, которую вы переводите физическому лицу или самозанятому. С помощью API вы можете создать выплату и получить о ней актуальную информацию. + +Выплаты используются в следующих платежных решениях ЮKassa: + +* Выплаты — вы как компания переводите деньги физическим лицам и самозанятым (например, выплачиваете кэшбек пользователям). +* Безопасная сделка — ваша платформа в рамках созданной сделки переводит оплату от одного физического лица другому. + +SDK позволяет проводить выплаты, а также получать информацию о них. + +Объект выплаты `PayoutResponse` содержит всю информацию о выплате, актуальную на текущий момент времени. Он формируется при создании выплаты и приходит в ответ на любой запрос, связанный с выплатами. + +Набор возвращаемых параметров зависит от статуса объекта (значение параметра status) и того, какие параметры вы передали в запросе на создание выплаты. + +* [Запрос на выплату продавцу](#Запрос-на-выплату-продавцу) +* [Получить информацию о выплате](#Получить-информацию-о-выплате) + +--- + +### Запрос на выплату продавцу + +[Выплата продавцу в документации](https://yookassa.ru/developers/api?lang=php#create_payout) + +Запрос позволяет перечислить продавцу оплату за выполненную услугу или проданный товар в рамках Безопасной сделки. +Выплату можно сделать на банковскую карту или на кошелек ЮMoney. + +В ответ на запрос придет объект выплаты - `PayoutResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$request = array( + 'amount' => array( + 'value' => '80.00', + 'currency' => 'RUB', + ), + 'payout_destination_data' => array( + 'type' => PaymentMethodType::SBP, + 'bank_id' => '100000000111', + 'phone' => '79001002030', + ), + 'description' => 'Выплата по заказу №37', + 'metadata' => array( + 'order_id' => '37', + ), + 'payment_method_id' => '2a217a2d-000f-5000-9000-1bd6f124af9c', + 'self_employed' => array('id' => 'se-285c0ab7-0003-5000-9000-0e1166498fda'), + 'receipt_data' => array( + 'service_name' => 'Оказание услуг по доставке товара', + 'amount' => array( + 'value' => '10.00', + 'currency' => 'RUB', + ), + ), + 'personal_data' => array( + array( + 'id' => 'pd-285c0ab7-0003-5000-9000-0e1166498fda', + ), + ), +); +$idempotenceKey = uniqid('', true); +try { + $result = $client->createPayout($request, $idempotenceKey); +} catch (\Exception $e) { + $result = $e; +} + +var_dump($result); +``` +[Подробнее о проведении выплат](https://yookassa.ru/developers/solutions-for-platforms/safe-deal/integration/payouts) + +--- + +### Получить информацию о выплате + +[Информация о выплате в документации](https://yookassa.ru/developers/api?lang=php#get_payout) + +Запрос позволяет получить информацию о текущем состоянии выплаты по ее уникальному идентификатору. + +Данные для [аутентификации](https://yookassa.ru/developers/using-api/interaction-format#auth) запросов зависят от того, какое платежное решение вы используете — [обычные выплаты](https://yookassa.ru/developers/payouts/overview) или выплаты в рамках [Безопасной сделки](https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics). + +В ответ на запрос придет объект выплаты - `PayoutResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$payoutId = 'po-285c0ab7-0003-5000-9000-0e1166498fda'; +try { + $response = $client->getPayoutInfo($payoutId); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` diff --git a/docs/examples/07-self-employed.md b/docs/examples/07-self-employed.md new file mode 100644 index 00000000..15973048 --- /dev/null +++ b/docs/examples/07-self-employed.md @@ -0,0 +1,70 @@ +## Работа с самозанятыми + +Самозанятые — это люди, которые не имеют работодателя и наемных работников и получают доход, оказывая услуги или продавая товары собственного производства. При выплатах самозанятым каждая выплата будет считаться доходом самозанятого, и ЮKassa будет автоматически регистрировать ее в сервисе [Мой налог](https://lknpd.nalog.ru/). + +Информация о самозанятом нужна для проведения выплат самозанятым. [Как делать выплаты самозанятым](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed) + +SDK позволяет создавать самозанятого в ЮKassa, а также получать информацию о них. + +Объект самозанятого `SelfEmployed` содержит всю информацию о самозанятом, актуальную на текущий момент времени. Он формируется при создании самозанятого и приходит в ответ на любой запрос, связанный с самозанятыми. + +Набор возвращаемых параметров зависит от статуса объекта (значение параметра `status`) и того, какие параметры вы передали в запросе на создание самозанятого. + +* [Запрос на создание самозанятого](#Запрос-на-создание-самозанятого) +* [Получить информацию о самозанятом](#Получить-информацию-о-самозанятом) + +--- + +### Запрос на создание самозанятого + +Используйте этот запрос, чтобы создать в ЮKassa объект самозанятого. В запросе необходимо передать ИНН или телефон самозанятого для идентификации в сервисе Мой налог, сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков и описание самозанятого. + +Идентификатор созданного объекта самозанятого необходимо использовать в запросе на проведение выплаты. + +В ответ на запрос придет объект самозанятого - `SelfEmployedResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$request = array( + 'itn' => '123456789012', + 'phone' => '79001002030', + 'confirmation' => array( + 'type' => 'redirect' + ), +); +$idempotenceKey = uniqid('', true); +try { + $result = $client->createSelfEmployed($request, $idempotenceKey); +} catch (\Exception $e) { + $result = $e; +} + +var_dump($result); +``` +--- + +### Получить информацию о самозанятом + +С помощью этого запроса вы можете получить информацию о текущем статусе самозанятого по его уникальному идентификатору. + +В ответ на запрос придет объект самозанятого - `SelfEmployedResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$selfEmployedId = 'se-285c0ab7-0003-5000-9000-0e1166498fda'; +try { + $response = $client->getSelfEmployedInfo($selfEmployedId); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` diff --git a/docs/examples/08-personal-data.md b/docs/examples/08-personal-data.md new file mode 100644 index 00000000..dce13dc2 --- /dev/null +++ b/docs/examples/08-personal-data.md @@ -0,0 +1,72 @@ +## Работа с персональными данными + +Персональные данные пользователя — это фамилия, имя, отчество пользователя и другие данные о нём. + +Персональные данные пользователя нужны для проведения выплат через СБП с проверкой получателя. [Как делать выплаты с проверкой получателя](https://yookassa.ru/developers/payouts/scenario-extensions/recipient-check) + +SDK позволяет создавать персональные данные пользователя, а также получать информацию о них. + +Объект персональных данных `PersonalData` содержит актуальную информацию о персональных данных пользователя, сохраненных в ЮKassa. Он формируется при создании персональных данных и приходит в ответ на любой запрос, связанный с персональными данными пользователя. + +Набор возвращаемых параметров зависит от статуса объекта (значение параметра `status`) и того, какие параметры вы передали в запросе на создание персональных данных. + +* [Создание персональных данных](#Создание-персональных-данных) +* [Получить информацию о персональных данных](#Получить-информацию-о-персональных-данных) + +--- + +### Создание персональных данных + +Запрос позволяет создать в ЮKassa объект персональных данных. В запросе необходимо передать фамилию, имя, отчество пользователя и указать, с какой целью эти данные будут использоваться. + +Идентификатор созданного объекта персональных данных необходимо использовать в запросе на проведение выплаты через СБП с проверкой получателя. + +В ответ на запрос придет объект персональных данных - `PersonalDataResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$request = array( + 'type' => 'sbp_payout_recipient', + 'last_name' => 'Иванов', + 'first_name' => 'Иван', + 'middle_name' => 'Иванович', + 'metadata' => array( + 'email' => 'i.ivanov@ivan.name', + ), +); +$idempotenceKey = uniqid('', true); +try { + $result = $client->createPersonalData($request, $idempotenceKey); +} catch (\Exception $e) { + $result = $e; +} + +var_dump($result); +``` +--- + +### Получить информацию о персональных данных + +С помощью этого запроса вы можете получить информацию о текущем статусе объекта персональных данных по его уникальному идентификатору. + +В ответ на запрос придет объект персональных данных - `PersonalDataResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$personalDataId = 'pd-285c0ab7-0003-5000-9000-0e1166498fda'; +try { + $response = $client->getPersonalDataInfo($personalDataId); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` diff --git a/docs/examples/09-sbp-banks.md b/docs/examples/09-sbp-banks.md new file mode 100644 index 00000000..bd5a4a29 --- /dev/null +++ b/docs/examples/09-sbp-banks.md @@ -0,0 +1,33 @@ +## Работа со списком участников СБП + +Участники СБП — это банки и платежные сервисы, подключенные к СБП (Система быстрых платежей ЦБ РФ). + +SDK позволяет получить актуальный список всех участников СБП. +Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать в запросе на [создание выплаты](06-payouts.md#Запрос-на-выплату-продавцу). + +[Подробнее о выплатах через СБП](https://yookassa.ru/developers/payouts/making-payouts/sbp) + +* [Получить список участников СБП](#Получить-список-участников-СБП) + +--- + +### Получить список участников СБП + +В ответ на запрос вернется список участников СБП. Список будет отсортирован по идентификатору участника в порядке убывания. + +Объект участника СБП `SbpParticipantBank` содержит информацию о банке или платежном сервисе, подключенном к СБП. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $result = $client->getSbpBanks(); +} catch (\Exception $e) { + $result = $e; +} + +var_dump($result); +``` diff --git a/docs/examples/readme.md b/docs/examples/readme.md index bfc32c68..d74432d1 100644 --- a/docs/examples/readme.md +++ b/docs/examples/readme.md @@ -1,6 +1,7 @@ ## Примеры использования SDK #### [Настройки SDK API ЮKassa](01-configuration.md) +* [Установка дополнительных настроек для Curl](01-configuration.md#Установка-дополнительных-настроек-для-Curl) * [Аутентификация](01-configuration.md#Аутентификация) * [Статистические данные об используемом окружении](01-configuration.md#Статистические-данные-об-используемом-окружении) * [Получение информации о магазине](01-configuration.md#Получение-информации-о-магазине) @@ -31,7 +32,20 @@ * [Запрос на создание сделки](05-deals.md#Запрос-на-создание-сделки) * [Запрос на создание сделки через билдер](05-deals.md#Запрос-на-создание-сделки-через-билдер) * [Запрос на создание платежа с привязкой к сделке](05-deals.md#Запрос-на-создание-платежа-с-привязкой-к-сделке) -* [Запрос на выплату продавцу](05-deals.md#Запрос-на-выплату-продавцу) * [Получить информацию о сделке](05-deals.md#Получить-информацию-о-сделке) * [Получить список сделок с фильтрацией](05-deals.md#Получить-список-сделок-с-фильтрацией) -* [Получить информацию о выплате](05-deals.md#Получить-информацию-о-выплате) + +### [Работа с выплатами](06-payouts.md) +* [Запрос на выплату продавцу](06-payouts.md#Запрос-на-выплату-продавцу) +* [Получить информацию о выплате](06-payouts.md#Получить-информацию-о-выплате) + +### [Работа с самозанятыми](07-self-employed.md) +* [Запрос на создание самозанятого](07-self-employed.md#Запрос-на-создание-самозанятого) +* [Получить информацию о самозанятом](07-self-employed.md#Получить-информацию-о-самозанятом) + +### [Работа с персональными данными](08-personal-data.md) +* [Создание персональных данных](08-personal-data.md#Создание-персональных-данных) +* [Получить информацию о персональных данных](08-personal-data.md#Получить-информацию-о-персональных-данных) + +#### [Работа со списком участников СБП](09-sbp-banks.md) +* [Получить список участников СБП](09-sbp-banks.md#Получить-список-участников-СБП) diff --git a/docs/namespaces/default.md b/docs/namespaces/default.md index 383edf36..35c3c0ad 100644 --- a/docs/namespaces/default.md +++ b/docs/namespaces/default.md @@ -12,6 +12,63 @@ | ---- | ------- | | [\JsonSerializable](../classes/JsonSerializable.md) | | +### Constants + + +###### YOOKASSA_DATE +```php +YOOKASSA_DATE = "Y-m-d\\TH:i:s.uP" +``` + + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + +###### YOOKASSA_SDK_PSR_LOG_PATH +```php +YOOKASSA_SDK_PSR_LOG_PATH = \dirname(__FILE__) . '/../vendor/psr/log/Psr/Log' +``` + + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + +###### YOOKASSA_SDK_ROOT_PATH +The MIT License + +```php +YOOKASSA_SDK_ROOT_PATH = \dirname(__FILE__) +``` + +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. + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + ### Functions @@ -22,7 +79,7 @@ ``` **Details:** -* File: [lib/autoload.php](../files/lib-autoload.md) +* File: [lib/autoload.php](files/lib-autoload.md) ##### Parameters: | Type | Name | Description | @@ -34,7 +91,7 @@ ##### Tags | Tag | Version | Description | | --- | ------- | ----------- | -| package | | | +| package | | YooKassa | --- @@ -47,11 +104,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-client.md b/docs/namespaces/yookassa-client.md index ab8c6275..7e2a3cbc 100644 --- a/docs/namespaces/yookassa-client.md +++ b/docs/namespaces/yookassa-client.md @@ -28,11 +28,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-common-exceptions.md b/docs/namespaces/yookassa-common-exceptions.md index 3f2e6fee..2d1ead2f 100644 --- a/docs/namespaces/yookassa-common-exceptions.md +++ b/docs/namespaces/yookassa-common-exceptions.md @@ -36,11 +36,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-common.md b/docs/namespaces/yookassa-common.md index d0c4591b..3c678d1a 100644 --- a/docs/namespaces/yookassa-common.md +++ b/docs/namespaces/yookassa-common.md @@ -33,11 +33,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-helpers-config.md b/docs/namespaces/yookassa-helpers-config.md index a9beb7a4..f366ba5f 100644 --- a/docs/namespaces/yookassa-helpers-config.md +++ b/docs/namespaces/yookassa-helpers-config.md @@ -26,11 +26,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-helpers.md b/docs/namespaces/yookassa-helpers.md index f0caf945..9e493152 100644 --- a/docs/namespaces/yookassa-helpers.md +++ b/docs/namespaces/yookassa-helpers.md @@ -30,11 +30,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-confirmation.md b/docs/namespaces/yookassa-model-confirmation.md index 2606a0e7..18cba9af 100644 --- a/docs/namespaces/yookassa-model-confirmation.md +++ b/docs/namespaces/yookassa-model-confirmation.md @@ -27,11 +27,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-confirmationattributes.md b/docs/namespaces/yookassa-model-confirmationattributes.md index d47bc1f7..e55024c4 100644 --- a/docs/namespaces/yookassa-model-confirmationattributes.md +++ b/docs/namespaces/yookassa-model-confirmationattributes.md @@ -27,11 +27,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-deal.md b/docs/namespaces/yookassa-model-deal.md index 46a0fd0b..49dba429 100644 --- a/docs/namespaces/yookassa-model-deal.md +++ b/docs/namespaces/yookassa-model-deal.md @@ -31,11 +31,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-notification.md b/docs/namespaces/yookassa-model-notification.md index 78f35a3e..74ff3ac0 100644 --- a/docs/namespaces/yookassa-model-notification.md +++ b/docs/namespaces/yookassa-model-notification.md @@ -34,11 +34,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md b/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md index 87370e05..944cb19b 100644 --- a/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md +++ b/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md @@ -15,8 +15,8 @@ | Name | Summary | | ---- | ------- | | [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) | Данные об НДС | -| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md) | PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС |Код|Описание| --- | --- |7|7%| |10|10%| |18|18%| |20|20%| | -| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md) | PaymentDataB2bSberbankVatDataType - Способ расчёта НДС |Код|Описание| --- | --- |calculated|Сумма НДС включена в сумму платежа| |mixed|Разные ставки НДС для разных товаров| |untaxed|Сумма платежа НДС не облагается| | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md) | PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md) | PaymentDataB2bSberbankVatDataType - Способ расчёта НДС | --- @@ -28,11 +28,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata-b2b.md b/docs/namespaces/yookassa-model-paymentdata-b2b.md index e8904b2e..e202cf27 100644 --- a/docs/namespaces/yookassa-model-paymentdata-b2b.md +++ b/docs/namespaces/yookassa-model-paymentdata-b2b.md @@ -18,11 +18,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata.md b/docs/namespaces/yookassa-model-paymentdata.md index 2cff2f2d..75a8a419 100644 --- a/docs/namespaces/yookassa-model-paymentdata.md +++ b/docs/namespaces/yookassa-model-paymentdata.md @@ -41,11 +41,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md b/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md index bfc9208d..002d1171 100644 --- a/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md +++ b/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md @@ -26,11 +26,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod-b2b.md b/docs/namespaces/yookassa-model-paymentmethod-b2b.md index a85ba412..0e233bda 100644 --- a/docs/namespaces/yookassa-model-paymentmethod-b2b.md +++ b/docs/namespaces/yookassa-model-paymentmethod-b2b.md @@ -18,11 +18,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod.md b/docs/namespaces/yookassa-model-paymentmethod.md index 4398c0de..7676d7b4 100644 --- a/docs/namespaces/yookassa-model-paymentmethod.md +++ b/docs/namespaces/yookassa-model-paymentmethod.md @@ -14,12 +14,12 @@ | ---- | ------- | | [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) | Абстрактный класс, описывающий основные свойства и методы платежных методов | | [\YooKassa\Model\PaymentMethod\BankCard](../classes/YooKassa-Model-PaymentMethod-BankCard.md) | Класс, описывающий объект банковской карты | -| [\YooKassa\Model\PaymentMethod\BankCardSource](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md) | BankCardSource - Источник данных банковской карты |Код|Описание| --- | --- |apple_pay|Источник данных apple_pay| |google_pay|Источник данных google_pay| |mir_pay|Источник данных mir_pay| | +| [\YooKassa\Model\PaymentMethod\BankCardSource](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md) | BankCardSource - Источник данных банковской карты | | [\YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md) | Класс, описывающий метод оплаты, при оплате через Альфа Банк | | [\YooKassa\Model\PaymentMethod\PaymentMethodApplePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md) | Класс, описывающий метод оплаты, при оплате через Apple Pay | | [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) | Класс, описывающий метод оплаты, при оплате через Сбербанк Бизнес Онлайн | | [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) | Класс, описывающий метод оплаты банковской картой | -| [\YooKassa\Model\PaymentMethod\PaymentMethodCardType](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md) | Тип банковской карты. Возможные значения: - `MasterCard` (для карт Mastercard и Maestro), - `Visa` (для карт Visa и Visa Electron), - `Mir`, - `UnionPay`, - `JCB`, - `AmericanExpress`, - `DinersClub` - `Unknown`. | +| [\YooKassa\Model\PaymentMethod\PaymentMethodCardType](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md) | PaymentMethodCardType - Тип банковской карты. | | [\YooKassa\Model\PaymentMethod\PaymentMethodCash](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md) | Класс, описывающий метод оплаты, при оплате наличными через терминал | | [\YooKassa\Model\PaymentMethod\PaymentMethodFactory](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md) | Фабрика создания объекта платежных методов из массива | | [\YooKassa\Model\PaymentMethod\PaymentMethodGooglePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md) | Класс, описывающий метод оплаты, при оплате через Google Pay | @@ -44,11 +44,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-payout.md b/docs/namespaces/yookassa-model-payout.md index 5518a12f..542e8557 100644 --- a/docs/namespaces/yookassa-model-payout.md +++ b/docs/namespaces/yookassa-model-payout.md @@ -9,14 +9,18 @@ | Name | Summary | | ---- | ------- | | [\YooKassa\Model\Payout\AbstractPayoutDestination](../classes/YooKassa-Model-Payout-AbstractPayoutDestination.md) | Данные используемые для создания метода оплаты. | +| [\YooKassa\Model\Payout\IncomeReceipt](../classes/YooKassa-Model-Payout-IncomeReceipt.md) | Класс, представляющий модель IncomeReceipt. | | [\YooKassa\Model\Payout\PayoutCancellationDetails](../classes/YooKassa-Model-Payout-PayoutCancellationDetails.md) | PayoutCancellationDetails - Комментарий к отмене выплаты | | [\YooKassa\Model\Payout\PayoutCancellationDetailsPartyCode](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsPartyCode.md) | PayoutCancellationDetailsPartyCode - Возможные инициаторы отмены выплаты | | [\YooKassa\Model\Payout\PayoutCancellationDetailsReasonCode](../classes/YooKassa-Model-Payout-PayoutCancellationDetailsReasonCode.md) | PayoutCancellationDetailsReasonCode - Возможные причины отмены выплаты | | [\YooKassa\Model\Payout\PayoutDestinationBankCard](../classes/YooKassa-Model-Payout-PayoutDestinationBankCard.md) | PaymentDataBankCard Платежные данные для проведения оплаты при помощи банковской карты | | [\YooKassa\Model\Payout\PayoutDestinationBankCardCard](../classes/YooKassa-Model-Payout-PayoutDestinationBankCardCard.md) | Данные банковской карты Необходим при оплате PCI-DSS данными. | | [\YooKassa\Model\Payout\PayoutDestinationFactory](../classes/YooKassa-Model-Payout-PayoutDestinationFactory.md) | Фабрика создания объекта платежных методов из массива | -| [\YooKassa\Model\Payout\PayoutDestinationType](../classes/YooKassa-Model-Payout-PayoutDestinationType.md) | PayoutDestinationType - Виды выплат |Код|Описание| --- | --- |yoo_money|Выплата в кошелек ЮMoney| |bank_card|Выплата на произвольную банковскую карту| | +| [\YooKassa\Model\Payout\PayoutDestinationSbp](../classes/YooKassa-Model-Payout-PayoutDestinationSbp.md) | Класс, описывающий метод оплаты, при оплате через ЮMoney | +| [\YooKassa\Model\Payout\PayoutDestinationType](../classes/YooKassa-Model-Payout-PayoutDestinationType.md) | PayoutDestinationType - Виды выплат | | [\YooKassa\Model\Payout\PayoutDestinationYooMoney](../classes/YooKassa-Model-Payout-PayoutDestinationYooMoney.md) | Класс, описывающий метод оплаты, при оплате через ЮMoney | +| [\YooKassa\Model\Payout\PayoutSelfEmployed](../classes/YooKassa-Model-Payout-PayoutSelfEmployed.md) | Класс, представляющий модель PayoutSelfEmployed. | +| [\YooKassa\Model\Payout\SbpParticipantBank](../classes/YooKassa-Model-Payout-SbpParticipantBank.md) | Класс, представляющий модель SbpParticipantBank. | --- @@ -28,11 +32,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-personaldata.md b/docs/namespaces/yookassa-model-personaldata.md new file mode 100644 index 00000000..b79b8cc2 --- /dev/null +++ b/docs/namespaces/yookassa-model-personaldata.md @@ -0,0 +1,41 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PersonalData + +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) + +### Interfaces + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PersonalData\PersonalDataInterface](../classes/YooKassa-Model-PersonalData-PersonalDataInterface.md) | Класс, представляющий модель PersonalDataInterface. | + +### Classes + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PersonalData\PersonalData](../classes/YooKassa-Model-PersonalData-PersonalData.md) | Класс, представляющий модель PersonalData. | +| [\YooKassa\Model\PersonalData\PersonalDataCancellationDetails](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetails.md) | Класс, представляющий модель PersonalDataCancellationDetails. | +| [\YooKassa\Model\PersonalData\PersonalDataCancellationDetailsPartyCode](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsPartyCode.md) | PayoutCancellationDetailsPartyCode - Возможные участники процесса, которые приняли решение о прекращении хранения персональных данных. | +| [\YooKassa\Model\PersonalData\PersonalDataCancellationDetailsReasonCode](../classes/YooKassa-Model-PersonalData-PersonalDataCancellationDetailsReasonCode.md) | PayoutCancellationDetailsReasonCode - Возможные причины аннулирования хранения данных. | +| [\YooKassa\Model\PersonalData\PersonalDataStatus](../classes/YooKassa-Model-PersonalData-PersonalDataStatus.md) | Класс, представляющий модель PersonalDataStatus. | +| [\YooKassa\Model\PersonalData\PersonalDataType](../classes/YooKassa-Model-PersonalData-PersonalDataType.md) | Класс, представляющий модель PersonalDataType. | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-receipt.md b/docs/namespaces/yookassa-model-receipt.md index cab75661..3230a899 100644 --- a/docs/namespaces/yookassa-model-receipt.md +++ b/docs/namespaces/yookassa-model-receipt.md @@ -9,7 +9,7 @@ | Name | Summary | | ---- | ------- | | [\YooKassa\Model\Receipt\AdditionalUserProps](../classes/YooKassa-Model-Receipt-AdditionalUserProps.md) | Class AdditionalUserProps | -| [\YooKassa\Model\Receipt\AgentType](../classes/YooKassa-Model-Receipt-AgentType.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Receipt\AgentType](../classes/YooKassa-Model-Receipt-AgentType.md) | AgentType - Тип посредника | | [\YooKassa\Model\Receipt\IndustryDetails](../classes/YooKassa-Model-Receipt-IndustryDetails.md) | Class IndustryDetails | | [\YooKassa\Model\Receipt\MarkCodeInfo](../classes/YooKassa-Model-Receipt-MarkCodeInfo.md) | Class MarkCodeInfo | | [\YooKassa\Model\Receipt\MarkQuantity](../classes/YooKassa-Model-Receipt-MarkQuantity.md) | Class MarkQuantity | @@ -18,7 +18,7 @@ | [\YooKassa\Model\Receipt\PaymentSubject](../classes/YooKassa-Model-Receipt-PaymentSubject.md) | Признак предмета расчета передается в параметре `payment_subject`. | | [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) | Class ReceiptItemAmount | | [\YooKassa\Model\Receipt\ReceiptItemMeasure](../classes/YooKassa-Model-Receipt-ReceiptItemMeasure.md) | Мера количества предмета расчета передается в массиве `items`, в параметре `measure`. | -| [\YooKassa\Model\Receipt\SettlementType](../classes/YooKassa-Model-Receipt-SettlementType.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Receipt\SettlementType](../classes/YooKassa-Model-Receipt-SettlementType.md) | SettlementType - Тип расчета | --- @@ -30,11 +30,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-selfemployed.md b/docs/namespaces/yookassa-model-selfemployed.md new file mode 100644 index 00000000..8ae1055d --- /dev/null +++ b/docs/namespaces/yookassa-model-selfemployed.md @@ -0,0 +1,41 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\SelfEmployed + +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) + +### Interfaces + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\SelfEmployed\SelfEmployedInterface](../classes/YooKassa-Model-SelfEmployed-SelfEmployedInterface.md) | Класс, представляющий модель SelfEmployed. | + +### Classes + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\SelfEmployed\SelfEmployed](../classes/YooKassa-Model-SelfEmployed-SelfEmployed.md) | Класс, представляющий модель SelfEmployed. | +| [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmation.md) | Класс, представляющий модель SelfEmployedConfirmation. | +| [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationFactory](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationFactory.md) | Class ConfirmationFactory | +| [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationRedirect](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationRedirect.md) | Класс, представляющий модель SelfEmployedConfirmationRedirect. | +| [\YooKassa\Model\SelfEmployed\SelfEmployedConfirmationType](../classes/YooKassa-Model-SelfEmployed-SelfEmployedConfirmationType.md) | Класс, представляющий модель SelfEmployedConfirmationType. | +| [\YooKassa\Model\SelfEmployed\SelfEmployedStatus](../classes/YooKassa-Model-SelfEmployed-SelfEmployedStatus.md) | Класс, представляющий модель SelfEmployedStatus. | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-webhook.md b/docs/namespaces/yookassa-model-webhook.md index f0da35da..3c0d0317 100644 --- a/docs/namespaces/yookassa-model-webhook.md +++ b/docs/namespaces/yookassa-model-webhook.md @@ -20,11 +20,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model.md b/docs/namespaces/yookassa-model.md index 3a0d967c..79020b74 100644 --- a/docs/namespaces/yookassa-model.md +++ b/docs/namespaces/yookassa-model.md @@ -13,7 +13,9 @@ * [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) * [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) * [\YooKassa\Model\Payout](../namespaces/yookassa-model-payout.md) +* [\YooKassa\Model\PersonalData](../namespaces/yookassa-model-personaldata.md) * [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +* [\YooKassa\Model\SelfEmployed](../namespaces/yookassa-model-selfemployed.md) * [\YooKassa\Model\Webhook](../namespaces/yookassa-model-webhook.md) ### Interfaces @@ -50,20 +52,21 @@ | [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) | CancellationDetails - Комментарий к отмене платежа | | [\YooKassa\Model\CancellationDetailsPartyCode](../classes/YooKassa-Model-CancellationDetailsPartyCode.md) | CancellationDetailsPartyCode - Возможные инициаторы отмены платежа | | [\YooKassa\Model\CancellationDetailsReasonCode](../classes/YooKassa-Model-CancellationDetailsReasonCode.md) | CancellationDetailsReasonCode - Возможные причины отмены платежа | -| [\YooKassa\Model\ConfirmationType](../classes/YooKassa-Model-ConfirmationType.md) | ConfirmationType - Тип пользовательского процесса подтверждения платежа |Код|Описание| --- | --- |redirect|Необходимо направить плательщика на страницу партнера| |external|Необходимо ождать пока плательщик самостоятельно подтвердит платеж| |code_verification|Необходимо получить одноразовый код от плательщика для подтверждения платежа| |embedded|Необходимо получить токен для checkout.js| |qr|Необходимо получить QR-код| |mobile_application|необходимо совершить действия в мобильном приложении| | -| [\YooKassa\Model\CurrencyCode](../classes/YooKassa-Model-CurrencyCode.md) | CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol | +| [\YooKassa\Model\ConfirmationType](../classes/YooKassa-Model-ConfirmationType.md) | ConfirmationType - Тип пользовательского процесса подтверждения платежа | +| [\YooKassa\Model\CurrencyCode](../classes/YooKassa-Model-CurrencyCode.md) | CurrencyCode - Код валюты в формате [ISO-4217](https://www.iso.org/iso-4217-currency-codes.md). | +| [\YooKassa\Model\FraudData](../classes/YooKassa-Model-FraudData.md) | Класс, представляющий модель FraudData. | | [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) | Класс, описывающий маршрут | -| [\YooKassa\Model\Locale](../classes/YooKassa-Model-Locale.md) | Locale - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь |Код|Описание| --- | --- |ru_RU|Русский| |en_US|English| | +| [\YooKassa\Model\Locale](../classes/YooKassa-Model-Locale.md) | Locale - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь | | [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) | Metadata - Метаданные платежа указанные мерчантом. | | [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) | MonetaryAmount - Сумма определенная в валюте | -| [\YooKassa\Model\NotificationEventType](../classes/YooKassa-Model-NotificationEventType.md) | NotificationEventType - Тип уведомления |Код|Описание| --- | --- |payment.waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |payment.succeeded|Успешно оплачен и подтвержден магазином| |payment.canceled|Неуспех оплаты или отменен магазином| |refund.succeeded|Успешный возврат| |deal.closed|Сделка перешла в статус closed| |payout.canceled|Выплата перешла в статус canceled| |payout.succeeded|Выплата перешла в статус succeeded| | +| [\YooKassa\Model\NotificationEventType](../classes/YooKassa-Model-NotificationEventType.md) | NotificationEventType - Тип уведомления | | [\YooKassa\Model\NotificationType](../classes/YooKassa-Model-NotificationType.md) | Базовый класс генерируемых enum'ов | | [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) | Класс описывающий данные пассажира | | [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) | Payment - Данные о платеже | -| [\YooKassa\Model\PaymentMethodType](../classes/YooKassa-Model-PaymentMethodType.md) | PaymentMethodType - Тип источника средств для проведения платежа |Код|Описание| --- | --- |yoo_money|Платеж из кошелька ЮMoney| |bank_card|Платеж с произвольной банковской карты| |sberbank|Платеж СбербанкОнлайн| |cash|Платеж наличными| |mobile_balance|Платеж с баланса мобильного телефона| |apple_pay|Платеж ApplePay| |google_pay|Платеж Google Pay| |qiwi|Платеж из кошелька Qiwi| |webmoney|Платеж из кошелька Webmoney| |alfabank|Платеж через Альфа-Клик| |b2b_sberbank|Сбербанк Бизнес Онлайн| |tinkoff_bank|Интернет-банк Тинькофф| |psb|ПромсвязьБанк| |installments|Заплатить по частям| |wechat|Платеж через WeChat| |sbp|Платеж через через сервис быстрых платежей| | -| [\YooKassa\Model\PaymentStatus](../classes/YooKassa-Model-PaymentStatus.md) | PaymentStatus - Состояние платежа |Код|Описание| --- | --- |pending|Ожидает оплаты покупателем| |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |succeeded|Успешно оплачен и подтвержден магазином| |canceled|Неуспех оплаты или отменен магазином (cancel)| | +| [\YooKassa\Model\PaymentMethodType](../classes/YooKassa-Model-PaymentMethodType.md) | PaymentMethodType - Тип источника средств для проведения платежа | +| [\YooKassa\Model\PaymentStatus](../classes/YooKassa-Model-PaymentStatus.md) | PaymentStatus - Состояние платежа | | [\YooKassa\Model\Payout](../classes/YooKassa-Model-Payout.md) | Payout - Данные о выплате | -| [\YooKassa\Model\PayoutStatus](../classes/YooKassa-Model-PayoutStatus.md) | PayoutStatus - Статус выплаты |Код|Описание| --- | --- |pending|Выплата создана и ожидает подтверждения от эмитента| |succeeded|Выплата успешно завершена| |canceled|Выплата отменена| | +| [\YooKassa\Model\PayoutStatus](../classes/YooKassa-Model-PayoutStatus.md) | PayoutStatus - Статус выплаты | | [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) | Класс данных для формирования чека в онлайн-кассе (для соблюдения 54-ФЗ) | | [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) | Информация о плательщике | | [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) | Информация о товарной позиции в заказе, позиция фискального чека | @@ -71,7 +74,7 @@ | [\YooKassa\Model\ReceiptType](../classes/YooKassa-Model-ReceiptType.md) | ReceiptType - Тип чека в онлайн-кассе. | | [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) | Класс получателя платежа. | | [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) | Класс объекта с информацией о возврате платежа | -| [\YooKassa\Model\RefundStatus](../classes/YooKassa-Model-RefundStatus.md) | RefundStatus - Состояние возврата платежа |Код|Описание| --- | --- |pending|Ожидает обработки| |succeeded|Успешно возвращен| |canceled|В проведении возврата отказано| | +| [\YooKassa\Model\RefundStatus](../classes/YooKassa-Model-RefundStatus.md) | RefundStatus - Состояние возврата платежа | | [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) | Инициатор платежа или возврата. | | [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md) | Class SafeBaseDeal | | [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) | Class Settlement | @@ -79,7 +82,7 @@ | [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) | Информация о поставщике товара или услуги. | | [\YooKassa\Model\ThreeDSecure](../classes/YooKassa-Model-ThreeDSecure.md) | ThreeDSecure - Данные о прохождении пользователем аутентификации по 3‑D Secure для подтверждения платежа. | | [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) | Класс объекта распределения денег в магазин | -| [\YooKassa\Model\TransferStatus](../classes/YooKassa-Model-TransferStatus.md) | PaymentStatus - Статус операции распределения средств конечному получателю |Код|Описание| --- | --- |pending|Ожидает оплаты покупателем| |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |succeeded|Успешно оплачен и получен магазином| |canceled|Неуспех оплаты или отменен магазином (cancel)| | +| [\YooKassa\Model\TransferStatus](../classes/YooKassa-Model-TransferStatus.md) | PaymentStatus - Статус операции распределения средств конечному получателю | --- @@ -91,11 +94,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-deals.md b/docs/namespaces/yookassa-request-deals.md index 51877471..3d350aaf 100644 --- a/docs/namespaces/yookassa-request-deals.md +++ b/docs/namespaces/yookassa-request-deals.md @@ -36,11 +36,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payments-payment.md b/docs/namespaces/yookassa-request-payments-payment.md index 68989391..f577f66e 100644 --- a/docs/namespaces/yookassa-request-payments-payment.md +++ b/docs/namespaces/yookassa-request-payments-payment.md @@ -30,11 +30,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payments.md b/docs/namespaces/yookassa-request-payments.md index d7c9a7ef..a6ed701e 100644 --- a/docs/namespaces/yookassa-request-payments.md +++ b/docs/namespaces/yookassa-request-payments.md @@ -40,11 +40,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payouts-payoutdestinationdata.md b/docs/namespaces/yookassa-request-payouts-payoutdestinationdata.md index dc00d485..aeae8784 100644 --- a/docs/namespaces/yookassa-request-payouts-payoutdestinationdata.md +++ b/docs/namespaces/yookassa-request-payouts-payoutdestinationdata.md @@ -12,6 +12,7 @@ | [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataBankCard](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCard.md) | Класс PayoutDestinationDataBankCard Платежные данные для проведения оплаты при помощи банковской карты | | [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataBankCardCard](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataBankCardCard.md) | Класс PayoutDestinationDataBankCardCard | | [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataFactory](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataFactory.md) | Класс PayoutDestinationDataFactory | +| [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataSbp](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataSbp.md) | Класс PayoutDestinationDataSbp | | [\YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataYooMoney](../classes/YooKassa-Request-Payouts-PayoutDestinationData-PayoutDestinationDataYooMoney.md) | Класс PayoutDestinationDataYooMoney | --- @@ -24,11 +25,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payouts.md b/docs/namespaces/yookassa-request-payouts.md index 229092b2..68535d43 100644 --- a/docs/namespaces/yookassa-request-payouts.md +++ b/docs/namespaces/yookassa-request-payouts.md @@ -23,7 +23,11 @@ | [\YooKassa\Request\Payouts\CreatePayoutRequestBuilder](../classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md) | Класс билдера объектов запросов к API на создание платежа | | [\YooKassa\Request\Payouts\CreatePayoutRequestSerializer](../classes/YooKassa-Request-Payouts-CreatePayoutRequestSerializer.md) | Класс сериалайзера объекта запроса к API на проведение выплаты | | [\YooKassa\Request\Payouts\CreatePayoutResponse](../classes/YooKassa-Request-Payouts-CreatePayoutResponse.md) | Класс объекта ответа возвращаемого API при запросе на создание выплаты | +| [\YooKassa\Request\Payouts\IncomeReceiptData](../classes/YooKassa-Request-Payouts-IncomeReceiptData.md) | Класс, представляющий модель IncomeReceiptData. | +| [\YooKassa\Request\Payouts\PayoutPersonalData](../classes/YooKassa-Request-Payouts-PayoutPersonalData.md) | Класс, представляющий модель PayoutsPersonalData. | | [\YooKassa\Request\Payouts\PayoutResponse](../classes/YooKassa-Request-Payouts-PayoutResponse.md) | Класс объекта ответа, возвращаемого API при запросе конкретной выплаты | +| [\YooKassa\Request\Payouts\PayoutSelfEmployedInfo](../classes/YooKassa-Request-Payouts-PayoutSelfEmployedInfo.md) | Класс, представляющий модель PayoutSelfEmployedInfo. | +| [\YooKassa\Request\Payouts\SbpBanksResponse](../classes/YooKassa-Request-Payouts-SbpBanksResponse.md) | Класс, представляющий модель GetSbpBanksResponse. | --- @@ -35,11 +39,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-personaldata.md b/docs/namespaces/yookassa-request-personaldata.md new file mode 100644 index 00000000..cb70a378 --- /dev/null +++ b/docs/namespaces/yookassa-request-personaldata.md @@ -0,0 +1,39 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\PersonalData + +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) + +### Interfaces + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestInterface.md) | Класс, представляющий интерфейс SbpPayoutRecipientPersonalDataRequestInterface. | + +### Classes + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\PersonalData\CreatePersonalDataRequest](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequest.md) | Класс, представляющий модель CreatePersonalDataRequest. | +| [\YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md) | Класс билдера объектов запросов к API на создание платежа | +| [\YooKassa\Request\PersonalData\CreatePersonalDataRequestSerializer](../classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestSerializer.md) | Класс сериалайзера объекта запроса к API на проведение выплаты | +| [\YooKassa\Request\PersonalData\PersonalDataResponse](../classes/YooKassa-Request-PersonalData-PersonalDataResponse.md) | Класс, представляющий модель PersonalData. | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-receipts.md b/docs/namespaces/yookassa-request-receipts.md index ec85bb1f..6b00c0c4 100644 --- a/docs/namespaces/yookassa-request-receipts.md +++ b/docs/namespaces/yookassa-request-receipts.md @@ -41,11 +41,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-refunds.md b/docs/namespaces/yookassa-request-refunds.md index aae67f59..f16d55ea 100644 --- a/docs/namespaces/yookassa-request-refunds.md +++ b/docs/namespaces/yookassa-request-refunds.md @@ -36,11 +36,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-selfemployed.md b/docs/namespaces/yookassa-request-selfemployed.md new file mode 100644 index 00000000..847766ad --- /dev/null +++ b/docs/namespaces/yookassa-request-selfemployed.md @@ -0,0 +1,36 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\SelfEmployed + +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) + +### Classes + +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequest](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md) | Класс, представляющий модель SelfEmployedRequest. | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestBuilder.md) | Класс билдера объектов запросов к API на создание самозанятого | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmation.md) | Класс, представляющий модель SelfEmployedRequestConfirmation. | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationFactory](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationFactory.md) | Class SelfEmployedRequestConfirmationFactory | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmationRedirect](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestConfirmationRedirect.md) | Класс, представляющий модель SelfEmployedConfirmationAttrsRedirect. | +| [\YooKassa\Request\SelfEmployed\SelfEmployedRequestSerializer](../classes/YooKassa-Request-SelfEmployed-SelfEmployedRequestSerializer.md) | Класс сериалайзера объекта запроса к API на создание самозанятого | +| [\YooKassa\Request\SelfEmployed\SelfEmployedResponse](../classes/YooKassa-Request-SelfEmployed-SelfEmployedResponse.md) | Класс, представляющий модель SelfEmployed. | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) + +© 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-webhook.md b/docs/namespaces/yookassa-request-webhook.md index 24970472..df0828e4 100644 --- a/docs/namespaces/yookassa-request-webhook.md +++ b/docs/namespaces/yookassa-request-webhook.md @@ -20,11 +20,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request.md b/docs/namespaces/yookassa-request.md index e2247138..9605cb06 100644 --- a/docs/namespaces/yookassa-request.md +++ b/docs/namespaces/yookassa-request.md @@ -9,8 +9,10 @@ * [\YooKassa\Request\Deals](../namespaces/yookassa-request-deals.md) * [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) * [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) +* [\YooKassa\Request\PersonalData](../namespaces/yookassa-request-personaldata.md) * [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) * [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +* [\YooKassa\Request\SelfEmployed](../namespaces/yookassa-request-selfemployed.md) * [\YooKassa\Request\Webhook](../namespaces/yookassa-request-webhook.md) --- @@ -23,11 +25,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa.md b/docs/namespaces/yookassa.md index 62f69cde..99974ee9 100644 --- a/docs/namespaces/yookassa.md +++ b/docs/namespaces/yookassa.md @@ -28,11 +28,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md index 6d27db20..60dd441d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -12,6 +12,63 @@ | ---- | ------- | | [\JsonSerializable](classes/JsonSerializable.md) | | +### Constants + + +###### YOOKASSA_DATE +```php +YOOKASSA_DATE = "Y-m-d\\TH:i:s.uP" +``` + + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + +###### YOOKASSA_SDK_PSR_LOG_PATH +```php +YOOKASSA_SDK_PSR_LOG_PATH = \dirname(__FILE__) . '/../vendor/psr/log/Psr/Log' +``` + + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + +###### YOOKASSA_SDK_ROOT_PATH +The MIT License + +```php +YOOKASSA_SDK_ROOT_PATH = \dirname(__FILE__) +``` + +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. + +| Tag | Version | Desc | +| --- | ------- | ---- | +| package | | YooKassa | + + ### Functions @@ -34,7 +91,7 @@ ##### Tags | Tag | Version | Description | | --- | ------- | ----------- | -| package | | | +| package | | YooKassa | --- @@ -47,11 +104,11 @@ ### Reports * [Errors - 0](reports/errors.md) -* [Markers - 0](reports/markers.md) -* [Deprecated - 23](reports/deprecated.md) +* [Markers - 1](reports/markers.md) +* [Deprecated - 25](reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/reports/deprecated.md b/docs/reports/deprecated.md index 74bd3f25..b94cbf5d 100644 --- a/docs/reports/deprecated.md +++ b/docs/reports/deprecated.md @@ -2,23 +2,30 @@ # Deprecated Elements ### Table of Contents +* [lib/Model/ConfirmationType.php](../../lib/Model/ConfirmationType.php) * [lib/Model/Payment.php](../../lib/Model/Payment.php) * [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) * [lib/Model/PaymentMethod/PaymentMethodBankCard.php](../../lib/Model/PaymentMethod/PaymentMethodBankCard.php) * [lib/Model/PaymentMethod/PaymentMethodFactory.php](../../lib/Model/PaymentMethod/PaymentMethodFactory.php) * [lib/Model/PaymentMethod/PaymentMethodWechat.php](../../lib/Model/PaymentMethod/PaymentMethodWechat.php) * [lib/Model/PaymentMethodType.php](../../lib/Model/PaymentMethodType.php) +* [lib/Model/Payout/PayoutCancellationDetailsPartyCode.php](../../lib/Model/Payout/PayoutCancellationDetailsPartyCode.php) * [lib/Model/Receipt.php](../../lib/Model/Receipt.php) * [lib/Model/Refund.php](../../lib/Model/Refund.php) * [lib/Model/Requestor.php](../../lib/Model/Requestor.php) * [lib/Model/RequestorInterface.php](../../lib/Model/RequestorInterface.php) + +#### [lib/Model/ConfirmationType.php](../../lib/Model/ConfirmationType.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 52 | \YooKassa\Model\ConfirmationType::CODE_VERIFICATION | Будет удален в будущих версиях | #### [lib/Model/Payment.php](../../lib/Model/Payment.php) | Line | Element | Description | | ---- | ------- | ----------- | -| 692 | \YooKassa\Model\Payment::setRequestor() | Не используется. Будет удален в следующих версиях | -| 700 | \YooKassa\Model\Payment::getRequestor() | Не используется. Будет удален в следующих версиях | +| 710 | \YooKassa\Model\Payment::setRequestor() | Не используется. Будет удален в следующих версиях | +| 719 | \YooKassa\Model\Payment::getRequestor() | Не используется. Будет удален в следующих версиях | #### [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) | Line | Element | Description | @@ -52,30 +59,35 @@ | Line | Element | Description | | ---- | ------- | ----------- | | 86 | \YooKassa\Model\PaymentMethodType::WECHAT | Будет удален в следующих версиях | + +#### [lib/Model/Payout/PayoutCancellationDetailsPartyCode.php](../../lib/Model/Payout/PayoutCancellationDetailsPartyCode.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 40 | \YooKassa\Model\Payout\PayoutCancellationDetailsPartyCode::MERCHANT | Будет удален в будущих версиях | #### [lib/Model/Receipt.php](../../lib/Model/Receipt.php) | Line | Element | Description | | ---- | ------- | ----------- | -| 514 | \YooKassa\Model\Receipt::getPhone() | Устарел — данные рекомендуется брать в параметре receipt.customer.phone. | -| 528 | \YooKassa\Model\Receipt::setPhone() | Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. | -| 543 | \YooKassa\Model\Receipt::getEmail() | Устарел — данные рекомендуется брать в параметре receipt.customer.email. | -| 557 | \YooKassa\Model\Receipt::setEmail() | Устарел — данные рекомендуется передавать в параметре receipt.customer.email. | +| 529 | \YooKassa\Model\Receipt::getPhone() | Устарел — данные рекомендуется брать в параметре receipt.customer.phone. | +| 543 | \YooKassa\Model\Receipt::setPhone() | Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. | +| 558 | \YooKassa\Model\Receipt::getEmail() | Устарел — данные рекомендуется брать в параметре receipt.customer.email. | +| 572 | \YooKassa\Model\Receipt::setEmail() | Устарел — данные рекомендуется передавать в параметре receipt.customer.email. | #### [lib/Model/Refund.php](../../lib/Model/Refund.php) | Line | Element | Description | | ---- | ------- | ----------- | -| 365 | \YooKassa\Model\Refund::getRequestor() | Не используется. Будет удален в следующих версиях | -| 373 | \YooKassa\Model\Refund::setRequestor() | Не используется. Будет удален в следующих версиях | +| 383 | \YooKassa\Model\Refund::getRequestor() | Не используется. Будет удален в следующих версиях | +| 391 | \YooKassa\Model\Refund::setRequestor() | Не используется. Будет удален в следующих версиях | #### [lib/Model/Requestor.php](../../lib/Model/Requestor.php) | Line | Element | Description | | ---- | ------- | ----------- | -| 29 | \YooKassa\Model\Requestor | Не используется. Будет удален в следующих версиях | +| 51 | \YooKassa\Model\Requestor | Не используется. Будет удален в следующих версиях | #### [lib/Model/RequestorInterface.php](../../lib/Model/RequestorInterface.php) | Line | Element | Description | | ---- | ------- | ----------- | -| 17 | \YooKassa\Model\RequestorInterface | Не используется. Будет удален в следующих версиях | +| 40 | \YooKassa\Model\RequestorInterface | Не используется. Будет удален в следующих версиях | --- @@ -87,11 +99,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/reports/errors.md b/docs/reports/errors.md index 4d42c16d..a905acc5 100644 --- a/docs/reports/errors.md +++ b/docs/reports/errors.md @@ -13,11 +13,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/docs/reports/markers.md b/docs/reports/markers.md index 5ce5f548..8fb4cd43 100644 --- a/docs/reports/markers.md +++ b/docs/reports/markers.md @@ -1,7 +1,11 @@ # [YooKassa API SDK](../home.md) # Markers -**No markers have been found in this project.** +* 1 - lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php +### 1 - lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php +| Line | Type | Description | +| ---- | ---- | ----------- | +| 41 | TODO | @example 02-builder.php 11 78 Пример использования билдера | --- @@ -13,11 +17,11 @@ ### Reports * [Errors - 0](../reports/errors.md) -* [Markers - 0](../reports/markers.md) -* [Deprecated - 23](../reports/deprecated.md) +* [Markers - 1](../reports/markers.md) +* [Deprecated - 25](../reports/deprecated.md) --- -This document was automatically generated from source code comments on 2023-03-09 using [phpDocumentor](http://www.phpdoc.org/) +This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney \ No newline at end of file diff --git a/lib/Client.php b/lib/Client.php index e46de76f..98fad102 100644 --- a/lib/Client.php +++ b/lib/Client.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -48,7 +48,9 @@ use YooKassa\Helpers\UUID; use YooKassa\Model\DealInterface; use YooKassa\Model\PaymentInterface; use YooKassa\Model\PayoutInterface; +use YooKassa\Model\PersonalData\PersonalDataInterface; use YooKassa\Model\RefundInterface; +use YooKassa\Model\SelfEmployed\SelfEmployedInterface; use YooKassa\Model\Webhook\Webhook; use YooKassa\Request\Deals\CreateDealRequest; use YooKassa\Request\Deals\CreateDealRequestInterface; @@ -78,6 +80,11 @@ use YooKassa\Request\Payouts\CreatePayoutRequestInterface; use YooKassa\Request\Payouts\CreatePayoutRequestSerializer; use YooKassa\Request\Payouts\CreatePayoutResponse; use YooKassa\Request\Payouts\PayoutResponse; +use YooKassa\Request\Payouts\SbpBanksResponse; +use YooKassa\Request\PersonalData\CreatePersonalDataRequest; +use YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface; +use YooKassa\Request\PersonalData\CreatePersonalDataRequestSerializer; +use YooKassa\Request\PersonalData\PersonalDataResponse; use YooKassa\Request\Receipts\AbstractReceiptResponse; use YooKassa\Request\Receipts\CreatePostReceiptRequest; use YooKassa\Request\Receipts\CreatePostReceiptRequestInterface; @@ -96,6 +103,9 @@ use YooKassa\Request\Refunds\RefundsRequest; use YooKassa\Request\Refunds\RefundsRequestInterface; use YooKassa\Request\Refunds\RefundsRequestSerializer; use YooKassa\Request\Refunds\RefundsResponse; +use YooKassa\Request\SelfEmployed\SelfEmployedRequest; +use YooKassa\Request\SelfEmployed\SelfEmployedRequestSerializer; +use YooKassa\Request\SelfEmployed\SelfEmployedResponse; use YooKassa\Request\Webhook\WebhookListResponse; /** @@ -112,7 +122,7 @@ class Client extends BaseClient /** * Текущая версия библиотеки */ - const SDK_VERSION = '2.7.7'; + const SDK_VERSION = '2.8.0'; /** * Получить список платежей магазина @@ -123,7 +133,7 @@ class Client extends BaseClient * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе * на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. * - * @example 01-client.php 226 23 Получить список платежей магазина с фильтрацией + * @example 01-client.php 227 23 Получить список платежей магазина с фильтрацией * * @param PaymentsRequestInterface|array|null $filter * @@ -271,7 +281,7 @@ class Client extends BaseClient throw new \InvalidArgumentException('Invalid paymentId value'); } - $path = self::PAYMENTS_PATH.'/'.$paymentId; + $path = self::PAYMENTS_PATH . '/' . $paymentId; $response = $this->execute($path, HttpVerb::GET, null); @@ -326,7 +336,7 @@ class Client extends BaseClient throw new \InvalidArgumentException('Invalid paymentId value'); } - $path = '/payments/'.$paymentId.'/capture'; + $path = '/payments/' . $paymentId . '/capture'; $headers = array(); @@ -392,7 +402,7 @@ class Client extends BaseClient throw new \InvalidArgumentException('Invalid paymentId value'); } - $path = self::PAYMENTS_PATH.'/'.$paymentId.'/cancel'; + $path = self::PAYMENTS_PATH . '/' . $paymentId . '/cancel'; $headers = array(); if ($idempotencyKey) { $headers[self::IDEMPOTENCY_KEY_HEADER] = $idempotencyKey; @@ -422,7 +432,7 @@ class Client extends BaseClient * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе * на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. * - * @example 01-client.php 274 23 Получить список возвратов платежей магазина с фильтрацией + * @example 01-client.php 275 23 Получить список возвратов платежей магазина с фильтрацией * * @param RefundsRequestInterface|array|null $filter * @@ -555,7 +565,7 @@ class Client extends BaseClient } elseif (mb_strlen($refundId) !== 36) { throw new \InvalidArgumentException('Invalid refundId value'); } - $path = self::REFUNDS_PATH.'/'.$refundId; + $path = self::REFUNDS_PATH . '/' . $refundId; $response = $this->execute($path, HttpVerb::GET, null); @@ -634,7 +644,7 @@ class Client extends BaseClient * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. * Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. * - * @example 01-client.php 192 32 Удаление Webhook + * @example 01-client.php 192 33 Удаление Webhook * * @param string $webhookId Идентификатор Webhook * @param string|null $idempotencyKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) @@ -661,7 +671,7 @@ class Client extends BaseClient } else { $headers[self::IDEMPOTENCY_KEY_HEADER] = UUID::v4(); } - $path = self::WEBHOOKS_PATH.'/'.$webhookId; + $path = self::WEBHOOKS_PATH . '/' . $webhookId; $response = $this->execute($path, HttpVerb::DELETE, null, null, $headers); @@ -681,7 +691,7 @@ class Client extends BaseClient * * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * - * @example 01-client.php 192 32 Список созданных Webhook + * @example 01-client.php 192 33 Список созданных Webhook * * @return WebhookListResponse|null * @@ -723,7 +733,7 @@ class Client extends BaseClient * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. * В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. * - * @example 01-client.php 251 21 Получить список чеков магазина с фильтрацией + * @example 01-client.php 252 21 Получить список чеков магазина с фильтрацией * * @param PaymentInterface|RefundInterface|array|null $filter * @@ -858,7 +868,7 @@ class Client extends BaseClient throw new \InvalidArgumentException('Invalid receiptId value'); } - $path = self::RECEIPTS_PATH.'/'.$receiptId; + $path = self::RECEIPTS_PATH . '/' . $receiptId; $response = $this->execute($path, HttpVerb::GET, null); @@ -882,16 +892,17 @@ class Client extends BaseClient * Необходимо указать следующие параметры: * * * Дополнительные параметры: * * - * @example 01-client.php 299 18 Запрос на создание сделки + * @example 01-client.php 300 18 Запрос на создание сделки * * @param CreateDealRequestInterface|array $deal * @param string|null $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) @@ -946,7 +957,7 @@ class Client extends BaseClient * Запрос позволяет получить информацию о текущем состоянии сделки по её уникальному идентификатору. * Выдает объект чека {@link DealInteface} в актуальном статусе. * - * @example 01-client.php 317 8 Получить информацию о сделке + * @example 01-client.php 320 8 Получить информацию о сделке * * @param string $dealId Идентификатор сделки * @@ -972,7 +983,7 @@ class Client extends BaseClient throw new \InvalidArgumentException('Invalid dealId value'); } - $path = self::DEALS_PATH.'/'.$dealId; + $path = self::DEALS_PATH . '/' . $dealId; $response = $this->execute($path, HttpVerb::GET, null); @@ -996,7 +1007,7 @@ class Client extends BaseClient * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. * В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. * - * @example 01-client.php 327 27 Получить список сделок с фильтрацией + * @example 01-client.php 330 27 Получить список сделок с фильтрацией * * @param DealsRequestInterface|array|null $filter * @@ -1061,7 +1072,7 @@ class Client extends BaseClient * * * @param CreatePayoutRequestInterface|array $payout @@ -1148,7 +1159,7 @@ class Client extends BaseClient throw new InvalidPropertyValueTypeException('Invalid payoutId value: string required'); } - $path = self::PAYOUTS_PATH.'/'.$payoutId; + $path = self::PAYOUTS_PATH . '/' . $payoutId; $response = $this->execute($path, HttpVerb::GET, null); @@ -1208,4 +1219,256 @@ class Client extends BaseClient return $result; } + + /** + * Создание персональных данных + * + * Используйте этот запрос, чтобы создать в ЮKassa [объект персональных данных](#personal_data_object). + * В запросе необходимо передать фамилию, имя, отчество пользователя и указать, с какой целью эти данные будут использоваться. + * Идентификатор созданного объекта персональных данных необходимо использовать в запросе на проведение выплаты через СБП с проверкой получателя. + * [Подробнее о выплатах с проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) + * + * @example 01-client.php 397 16 Запрос на создание персональных данных + * + * @param CreatePersonalDataRequestInterface|array $request + * @param string|null $idempotencyKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) + * + * @return PersonalDataResponse|null Объект персональных данных + * + * @throws ApiException Неожиданный код ошибки. + * @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. + * @throws ForbiddenException Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. + * @throws InternalServerError Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. + * @throws NotFoundException Ресурс не найден. + * @throws ResponseProcessingException Запрос был принят на обработку, но она не завершена. + * @throws TooManyRequestsException Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. + * @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. + * @throws ExtensionNotFoundException Требуемое PHP расширение не установлено. + * @throws Exception + */ + public function createPersonalData($request, $idempotencyKey = null) + { + $path = self::PERSONAL_DATA_PATH; + + $headers = array(); + + if ($idempotencyKey) { + $headers[self::IDEMPOTENCY_KEY_HEADER] = $idempotencyKey; + } else { + $headers[self::IDEMPOTENCY_KEY_HEADER] = UUID::v4(); + } + if (is_array($request)) { + $request = CreatePersonalDataRequest::builder()->build($request); + } + + $serializer = new CreatePersonalDataRequestSerializer(); + $serializedData = $serializer->serialize($request); + $httpBody = $this->encodeData($serializedData); + + $response = $this->execute($path, HttpVerb::POST, array(), $httpBody, $headers); + + $result = null; + if ($response->getCode() === 200) { + $resultArray = $this->decodeData($response); + $result = new PersonalDataResponse($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } + + /** + * Получить информацию о персональных данных + * + * Запрос позволяет получить информацию о текущем состоянии персональных данных по их уникальному идентификатору. + * Выдает объект платежа {@link PersonalDataInterface} в актуальном статусе. + * + * @example 01-client.php 415 8 Получить информацию о персональных данных + * + * @param string $personalDataId Идентификатор персональных данных + * + * @return PersonalDataInterface|null Объект персональных данных + * + * @throws ApiException Неожиданный код ошибки. + * @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. + * @throws ForbiddenException Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. + * @throws InternalServerError Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. + * @throws NotFoundException Ресурс не найден. + * @throws ResponseProcessingException Запрос был принят на обработку, но она не завершена. + * @throws TooManyRequestsException Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. + * @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. + * @throws ExtensionNotFoundException Требуемое PHP расширение не установлено. + */ + public function getPersonalDataInfo($personalDataId) + { + if ($personalDataId === null) { + throw new \InvalidArgumentException('Missing the required parameter $personalDataId'); + } + if (!TypeCast::canCastToString($personalDataId)) { + throw new \InvalidArgumentException('Invalid personalDataId value: string required'); + } + if (mb_strlen($personalDataId) < PersonalDataInterface::MIN_LENGTH_ID || mb_strlen($personalDataId) > PersonalDataInterface::MAX_LENGTH_ID) { + throw new \InvalidArgumentException('Invalid personalDataId value'); + } + + $path = self::PERSONAL_DATA_PATH . '/' . $personalDataId; + + $response = $this->execute($path, HttpVerb::GET, array()); + + $result = null; + if ($response->getCode() === 200) { + $resultArray = $this->decodeData($response); + $result = new PersonalDataResponse($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } + + /** + * Получить список участников СБП + * + * С помощью этого запроса вы можете получить актуальный список всех участников СБП. + * Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать + * в запросе на создание выплаты. + * + * @example 01-client.php 415 7 Получить информацию о персональных данных + * + * @return SbpBanksResponse|null + * + * @throws ApiException Неожиданный код ошибки. + * @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. + * @throws ForbiddenException Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. + * @throws InternalServerError Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. + * @throws NotFoundException Ресурс не найден. + * @throws ResponseProcessingException Запрос был принят на обработку, но она не завершена. + * @throws TooManyRequestsException Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. + * @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. + * @throws ExtensionNotFoundException Требуемое PHP расширение не установлено. + */ + public function getSbpBanks() + { + $path = self::SBP_BANKS_PATH; + + $response = $this->execute($path, HttpVerb::GET, array()); + + $result = null; + if ($response->getCode() === 200) { + $resultArray = $this->decodeData($response); + $result = new SbpBanksResponse($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } + + + /** + * Создание самозанятого. + * + * Используйте этот запрос, чтобы создать в ЮKassa [объект самозанятого](https://yookassa.ru/developers/api?codeLang=bash#self_employed_object). + * + * В запросе необходимо передать ИНН или телефон самозанятого для идентификации в сервисе Мой налог, + * сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков и описание самозанятого. + * + * Идентификатор созданного объекта самозанятого необходимо использовать в запросе на проведение выплаты. + * + * @example 01-client.php 425 14 Запрос на создание самозанятого + * + * @param SelfEmployedRequest|array $selfEmployed + * @param string|null $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) + * + * @return SelfEmployedResponse|null + * + * @throws ApiException Неожиданный код ошибки. + * @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. + * @throws ForbiddenException Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. + * @throws InternalServerError Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. + * @throws NotFoundException Ресурс не найден. + * @throws ResponseProcessingException Запрос был принят на обработку, но она не завершена. + * @throws TooManyRequestsException Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. + * @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. + * @throws ExtensionNotFoundException Требуемое PHP расширение не установлено. + */ + public function createSelfEmployed($selfEmployed, $idempotenceKey = null) + { + $path = self::SELF_EMPLOYED_PATH; + + $headers = array(); + + if ($idempotenceKey) { + $headers[self::IDEMPOTENCY_KEY_HEADER] = $idempotenceKey; + } else { + $headers[self::IDEMPOTENCY_KEY_HEADER] = UUID::v4(); + } + + $request = is_array($selfEmployed) ? SelfEmployedRequest::builder()->build($selfEmployed) : $selfEmployed; + + $serializer = new SelfEmployedRequestSerializer(); + $serializedData = $serializer->serialize($request); + $httpBody = $this->encodeData($serializedData); + + $response = $this->execute($path, HttpVerb::POST, array(), $httpBody, $headers); + + $result = null; + if ($response->getCode() === 200) { + $resultArray = $this->decodeData($response); + $result = new SelfEmployedResponse($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } + + /** + * Получить информацию о самозанятом + * + * С помощью этого запроса вы можете получить информацию о текущем статусе самозанятого по его уникальному идентификатору. + * + * @example 01-client.php 441 8 Получить информацию о самозанятом + * + * @param string $selfEmployedId Идентификатор самозанятого + * + * @return SelfEmployedInterface|null Объект информации о самозанятом + * + * @throws ApiException Неожиданный код ошибки. + * @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. + * @throws ForbiddenException Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. + * @throws InternalServerError Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. + * @throws NotFoundException Ресурс не найден. + * @throws ResponseProcessingException Запрос был принят на обработку, но она не завершена. + * @throws TooManyRequestsException Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. + * @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации. + * @throws ExtensionNotFoundException Требуемое PHP расширение не установлено. + */ + public function getSelfEmployedInfo($selfEmployedId) + { + if ($selfEmployedId === null) { + throw new \InvalidArgumentException('Missing the required parameter $selfEmployedId'); + } + if (!TypeCast::canCastToString($selfEmployedId)) { + throw new \InvalidArgumentException('Invalid selfEmployedId value: string required'); + } + if (mb_strlen($selfEmployedId) < SelfEmployedInterface::MIN_LENGTH_ID || mb_strlen($selfEmployedId) > SelfEmployedInterface::MAX_LENGTH_ID) { + throw new \InvalidArgumentException('Invalid selfEmployedId value'); + } + + $path = self::SELF_EMPLOYED_PATH . '/' . $selfEmployedId; + + $response = $this->execute($path, HttpVerb::GET, array()); + + $result = null; + if ($response->getCode() === 200) { + $resultArray = $this->decodeData($response); + $result = new SelfEmployedResponse($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } } diff --git a/lib/Client/ApiClientInterface.php b/lib/Client/ApiClientInterface.php index 916c6716..9ee10686 100644 --- a/lib/Client/ApiClientInterface.php +++ b/lib/Client/ApiClientInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Client/BaseClient.php b/lib/Client/BaseClient.php index f12cc24a..3049d188 100644 --- a/lib/Client/BaseClient.php +++ b/lib/Client/BaseClient.php @@ -1,8 +1,9 @@ setCurlOption(CURLOPT_CUSTOMREQUEST, $method); - if(!empty($httpBody)) { + if (!empty($httpBody)) { $this->setCurlOption(CURLOPT_POSTFIELDS, $httpBody); } } @@ -413,7 +413,7 @@ class CurlClient implements ApiClientInterface if ($this->shopId && $this->shopPassword) { $encodedAuth = base64_encode($this->shopId . ':' . $this->shopPassword); $headers['Authorization'] = 'Basic ' . $encodedAuth; - } else if ($this->bearerToken) { + } elseif ($this->bearerToken) { $headers['Authorization'] = 'Bearer ' . $this->bearerToken; } @@ -430,7 +430,9 @@ class CurlClient implements ApiClientInterface */ private function implodeHeaders($headers) { - return array_map(function ($key, $value) { return $key . ':' . $value; }, array_keys($headers), $headers); + return array_map(function ($key, $value) { + return $key . ':' . $value; + }, array_keys($headers), $headers); } /** diff --git a/lib/Client/UserAgent.php b/lib/Client/UserAgent.php index a840bb51..be2c3a29 100644 --- a/lib/Client/UserAgent.php +++ b/lib/Client/UserAgent.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Client; - use YooKassa\Client; /** @@ -346,5 +345,4 @@ class UserAgent . self::VERSION_DELIMITER . str_replace(array(self::PART_DELIMITER, self::VERSION_DELIMITER), '.', trim($version)); } - } diff --git a/lib/Common/AbstractEnum.php b/lib/Common/AbstractEnum.php index efd5062c..7e17adc4 100644 --- a/lib/Common/AbstractEnum.php +++ b/lib/Common/AbstractEnum.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/AbstractObject.php b/lib/Common/AbstractObject.php index 97f2cc65..07ca827e 100644 --- a/lib/Common/AbstractObject.php +++ b/lib/Common/AbstractObject.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -90,11 +90,11 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable { $method = 'get' . ucfirst($offset); if (method_exists($this, $method)) { - return $this->{$method} (); + return $this->{$method}(); } $method = 'get' . self::matchPropertyName($offset); if (method_exists($this, $method)) { - return $this->{$method} (); + return $this->{$method}(); } return array_key_exists($offset, $this->unknownProperties) ? $this->unknownProperties[$offset] : null; } @@ -131,11 +131,11 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable { $method = 'set' . ucfirst($offset); if (method_exists($this, $method)) { - $this->{$method} (null); + $this->{$method}(null); } else { $method = 'set' . self::matchPropertyName($offset); if (method_exists($this, $method)) { - $this->{$method} (null); + $this->{$method}(null); } else { unset($this->unknownProperties[$offset]); } @@ -219,7 +219,7 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable continue; } $property = strtolower(preg_replace('/[A-Z]/', '_\0', lcfirst(substr($method, 3)))); - $value = $this->serializeValueToJson($this->{$method} ()); + $value = $this->serializeValueToJson($this->{$method}()); if ($value !== null) { $result[$property] = $value; } diff --git a/lib/Common/AbstractPaymentRequest.php b/lib/Common/AbstractPaymentRequest.php index ebea4b94..2551134b 100644 --- a/lib/Common/AbstractPaymentRequest.php +++ b/lib/Common/AbstractPaymentRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -234,5 +234,4 @@ class AbstractPaymentRequest extends AbstractRequest return true; } - } diff --git a/lib/Common/AbstractPaymentRequestBuilder.php b/lib/Common/AbstractPaymentRequestBuilder.php index d3d10bbe..42cc21de 100644 --- a/lib/Common/AbstractPaymentRequestBuilder.php +++ b/lib/Common/AbstractPaymentRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -193,18 +193,18 @@ abstract class AbstractPaymentRequestBuilder extends AbstractRequestBuilder } else { if (empty($item['title']) && empty($item['description'])) { throw new InvalidPropertyValueException( - 'Item#'.$index.' title or description not specified', + 'Item#' . $index . ' title or description not specified', 0, - 'AbstractPaymentRequestBuilder.items['.$index.'].title', + 'AbstractPaymentRequestBuilder.items[' . $index . '].title', json_encode($item) ); } foreach (array('price', 'quantity', 'vatCode') as $property) { if (empty($item[$property])) { throw new InvalidPropertyValueException( - 'Item#'.$index.' '.$property.' not specified', + 'Item#' . $index . ' ' . $property . ' not specified', 0, - 'AbstractPaymentRequestBuilder.items['.$index.'].'.$property, + 'AbstractPaymentRequestBuilder.items[' . $index . '].' . $property, json_encode($item) ); } diff --git a/lib/Common/AbstractRefundRequest.php b/lib/Common/AbstractRefundRequest.php index c5955a31..9daca004 100644 --- a/lib/Common/AbstractRefundRequest.php +++ b/lib/Common/AbstractRefundRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -91,19 +91,27 @@ class AbstractRefundRequest extends AbstractRequest { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId' + 'Empty payment id value in CreateRefundRequest', + 0, + 'CreateRefundRequest.paymentId' ); } elseif (TypeCast::canCastToString($value)) { $length = mb_strlen($value, 'utf-8'); if ($length != 36) { throw new InvalidPropertyValueException( - 'Invalid payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value + 'Invalid payment id value in CreateRefundRequest', + 0, + 'CreateRefundRequest.paymentId', + $value ); } $this->_paymentId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment id value type in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value + 'Invalid payment id value type in CreateRefundRequest', + 0, + 'CreateRefundRequest.paymentId', + $value ); } } @@ -219,5 +227,4 @@ class AbstractRefundRequest extends AbstractRequest return true; } - } diff --git a/lib/Common/AbstractRequest.php b/lib/Common/AbstractRequest.php index bb34df36..f642954c 100644 --- a/lib/Common/AbstractRequest.php +++ b/lib/Common/AbstractRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/AbstractRequestBuilder.php b/lib/Common/AbstractRequestBuilder.php index d785f390..0a50f0ac 100644 --- a/lib/Common/AbstractRequestBuilder.php +++ b/lib/Common/AbstractRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -104,13 +104,13 @@ abstract class AbstractRequestBuilder foreach ($options as $property => $value) { $method = 'set' . ucfirst($property); if (method_exists($this, $method)) { - $this->{$method} ($value); + $this->{$method}($value); } else { $property = str_replace('.', '_', $property); $field = implode('', array_map('ucfirst', explode('_', $property))); $method = 'set' . ucfirst($field); if (method_exists($this, $method)) { - $this->{$method} ($value); + $this->{$method}($value); } } } diff --git a/lib/Common/Exceptions/ApiConnectionException.php b/lib/Common/Exceptions/ApiConnectionException.php index 5c2b6518..0851f459 100644 --- a/lib/Common/Exceptions/ApiConnectionException.php +++ b/lib/Common/Exceptions/ApiConnectionException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -28,5 +28,4 @@ namespace YooKassa\Common\Exceptions; class ApiConnectionException extends ApiException { - } diff --git a/lib/Common/Exceptions/ApiException.php b/lib/Common/Exceptions/ApiException.php index 2faeee3e..051a12b4 100644 --- a/lib/Common/Exceptions/ApiException.php +++ b/lib/Common/Exceptions/ApiException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/AuthorizeException.php b/lib/Common/Exceptions/AuthorizeException.php index 29478fa9..59c7018e 100644 --- a/lib/Common/Exceptions/AuthorizeException.php +++ b/lib/Common/Exceptions/AuthorizeException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -33,5 +33,4 @@ namespace YooKassa\Common\Exceptions; */ class AuthorizeException extends ApiException { - } diff --git a/lib/Common/Exceptions/BadApiRequestException.php b/lib/Common/Exceptions/BadApiRequestException.php index 85630ca9..f35fb441 100644 --- a/lib/Common/Exceptions/BadApiRequestException.php +++ b/lib/Common/Exceptions/BadApiRequestException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/EmptyPropertyValueException.php b/lib/Common/Exceptions/EmptyPropertyValueException.php index e42863f9..3494e5dd 100644 --- a/lib/Common/Exceptions/EmptyPropertyValueException.php +++ b/lib/Common/Exceptions/EmptyPropertyValueException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/ExtensionNotFoundException.php b/lib/Common/Exceptions/ExtensionNotFoundException.php index 3ae9a23a..ad5e0cda 100644 --- a/lib/Common/Exceptions/ExtensionNotFoundException.php +++ b/lib/Common/Exceptions/ExtensionNotFoundException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/ForbiddenException.php b/lib/Common/Exceptions/ForbiddenException.php index 96a9c4a3..9f33cbc2 100644 --- a/lib/Common/Exceptions/ForbiddenException.php +++ b/lib/Common/Exceptions/ForbiddenException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/InternalServerError.php b/lib/Common/Exceptions/InternalServerError.php index 17e62975..878e5835 100644 --- a/lib/Common/Exceptions/InternalServerError.php +++ b/lib/Common/Exceptions/InternalServerError.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/InvalidPropertyException.php b/lib/Common/Exceptions/InvalidPropertyException.php index 44e4be4c..c1c9a0dc 100644 --- a/lib/Common/Exceptions/InvalidPropertyException.php +++ b/lib/Common/Exceptions/InvalidPropertyException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/InvalidPropertyValueException.php b/lib/Common/Exceptions/InvalidPropertyValueException.php index 443fe6e5..d5a46405 100644 --- a/lib/Common/Exceptions/InvalidPropertyValueException.php +++ b/lib/Common/Exceptions/InvalidPropertyValueException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/InvalidPropertyValueTypeException.php b/lib/Common/Exceptions/InvalidPropertyValueTypeException.php index ad740b46..b1010f91 100644 --- a/lib/Common/Exceptions/InvalidPropertyValueTypeException.php +++ b/lib/Common/Exceptions/InvalidPropertyValueTypeException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/InvalidRequestException.php b/lib/Common/Exceptions/InvalidRequestException.php index f70747dd..f0e6d637 100644 --- a/lib/Common/Exceptions/InvalidRequestException.php +++ b/lib/Common/Exceptions/InvalidRequestException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -44,7 +44,7 @@ class InvalidRequestException extends \RuntimeException public function __construct($error, $code = 0, $previous = null) { if ($error instanceof AbstractRequest) { - $message = 'Failed to build request "'.get_class($error).'": "'.$error->getLastValidationError().'"'; + $message = 'Failed to build request "' . get_class($error) . '": "' . $error->getLastValidationError() . '"'; $this->errorRequest = $error; } else { $message = $error; diff --git a/lib/Common/Exceptions/JsonException.php b/lib/Common/Exceptions/JsonException.php index 840263dd..1a14ca67 100644 --- a/lib/Common/Exceptions/JsonException.php +++ b/lib/Common/Exceptions/JsonException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/NotFoundException.php b/lib/Common/Exceptions/NotFoundException.php index dac46c05..2d75608b 100644 --- a/lib/Common/Exceptions/NotFoundException.php +++ b/lib/Common/Exceptions/NotFoundException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class NotFoundException extends ApiException $message = ''; if (isset($errorData['description'])) { - $message .= $errorData['description'].'. '; + $message .= $errorData['description'] . '. '; } if (isset($errorData['code'])) { diff --git a/lib/Common/Exceptions/ResponseProcessingException.php b/lib/Common/Exceptions/ResponseProcessingException.php index f5163a83..2f36c926 100644 --- a/lib/Common/Exceptions/ResponseProcessingException.php +++ b/lib/Common/Exceptions/ResponseProcessingException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/TooManyRequestsException.php b/lib/Common/Exceptions/TooManyRequestsException.php index 54eb3a5c..ae2e7714 100644 --- a/lib/Common/Exceptions/TooManyRequestsException.php +++ b/lib/Common/Exceptions/TooManyRequestsException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/Exceptions/UnauthorizedException.php b/lib/Common/Exceptions/UnauthorizedException.php index aeb86c52..94166ab0 100644 --- a/lib/Common/Exceptions/UnauthorizedException.php +++ b/lib/Common/Exceptions/UnauthorizedException.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/HttpVerb.php b/lib/Common/HttpVerb.php index 01a9b7a9..bd243816 100644 --- a/lib/Common/HttpVerb.php +++ b/lib/Common/HttpVerb.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -28,12 +28,19 @@ namespace YooKassa\Common; class HttpVerb extends AbstractEnum { + /** Http метод GET */ const GET = 'GET'; + /** Http метод POST */ const POST = 'POST'; + /** Http метод PATCH */ const PATCH = 'PATCH'; + /** Http метод HEAD */ const HEAD = 'HEAD'; + /** Http метод OPTIONS */ const OPTIONS = 'OPTIONS'; + /** Http метод PUT */ const PUT = 'PUT'; + /** Http метод DELETE */ const DELETE = 'DELETE'; protected static $validValues = array( diff --git a/lib/Common/LoggerWrapper.php b/lib/Common/LoggerWrapper.php index 7d2defbf..09bfd773 100644 --- a/lib/Common/LoggerWrapper.php +++ b/lib/Common/LoggerWrapper.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/ResponseObject.php b/lib/Common/ResponseObject.php index c9590614..cbf0cfac 100644 --- a/lib/Common/ResponseObject.php +++ b/lib/Common/ResponseObject.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Common/legacy_json_serializable.php b/lib/Common/legacy_json_serializable.php index b9bdfd2f..32ccd75d 100644 --- a/lib/Common/legacy_json_serializable.php +++ b/lib/Common/legacy_json_serializable.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -25,7 +25,8 @@ */ if (!interface_exists('JsonSerializable')) { - interface JsonSerializable { + interface JsonSerializable + { public function jsonSerialize(); } } diff --git a/lib/Helpers/Config/ConfigurationLoader.php b/lib/Helpers/Config/ConfigurationLoader.php index ecd457e1..b5e280dc 100644 --- a/lib/Helpers/Config/ConfigurationLoader.php +++ b/lib/Helpers/Config/ConfigurationLoader.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Helpers/Config/ConfigurationLoaderInterface.php b/lib/Helpers/Config/ConfigurationLoaderInterface.php index 1a761fd1..7f891e9b 100644 --- a/lib/Helpers/Config/ConfigurationLoaderInterface.php +++ b/lib/Helpers/Config/ConfigurationLoaderInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Helpers/ProductCode.php b/lib/Helpers/ProductCode.php index 81bf13c4..4ea5ceae 100644 --- a/lib/Helpers/ProductCode.php +++ b/lib/Helpers/ProductCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -136,7 +136,7 @@ class ProductCode * @param string|null $codeDataMatrix Строка, расшифрованная из QR-кода * @param bool|string $usePrefix Нужен ли код типа маркировки в результате */ - public function __construct($codeDataMatrix=null, $usePrefix=true) + public function __construct($codeDataMatrix = null, $usePrefix = true) { $this->preparePrefix($usePrefix); @@ -618,7 +618,7 @@ class ProductCode */ private function numToHex($string) { - return str_pad($this->base_convert($string), 12, '0', STR_PAD_LEFT); + return str_pad($this->baseConvert($string), 12, '0', STR_PAD_LEFT); } /** @@ -630,7 +630,7 @@ class ProductCode * @param int $toBase * @return string */ - private function base_convert($numString, $fromBase=10, $toBase=16) + private function baseConvert($numString, $fromBase = 10, $toBase = 16) { $chars = "0123456789abcdefghijklmnopqrstuvwxyz"; $toString = substr($chars, 0, $toBase); @@ -702,5 +702,4 @@ class ProductCode { return $this->getResult(); } - } diff --git a/lib/Helpers/Random.php b/lib/Helpers/Random.php index bd96475b..96ca01f9 100644 --- a/lib/Helpers/Random.php +++ b/lib/Helpers/Random.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -89,11 +89,11 @@ class Random { $result = ''; if ($maxLength !== null) { - if (is_string($maxLength)) { - $characters = $maxLength; - } else { - $length = self::int($length, $maxLength, $useBest); - } + if (is_string($maxLength)) { + $characters = $maxLength; + } else { + $length = self::int($length, $maxLength, $useBest); + } } if ($characters === null) { for ($i = 0; $i < $length; $i++) { diff --git a/lib/Helpers/RawHeadersParser.php b/lib/Helpers/RawHeadersParser.php index 67a8b78b..a3ce7fab 100644 --- a/lib/Helpers/RawHeadersParser.php +++ b/lib/Helpers/RawHeadersParser.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Helpers/SecurityHelper.php b/lib/Helpers/SecurityHelper.php index a650d4b0..5e6643d2 100644 --- a/lib/Helpers/SecurityHelper.php +++ b/lib/Helpers/SecurityHelper.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -39,7 +39,7 @@ class SecurityHelper public function isIPTrusted($ip) { if (!$this->isIPv6($ip)) { - return $this->checkInIPv4TrustedList($ip); + return $this->checkInIPv4TrustedList($ip); } if (!$this->isIPv4($ip)) { @@ -80,7 +80,7 @@ class SecurityHelper */ private function checkInIPv4TrustedList($ip) { - foreach($this->getIPv4TrustedList() as $range) { + foreach ($this->getIPv4TrustedList() as $range) { if ($this->isIPInV4Range($ip, $range)) { return true; } @@ -96,7 +96,7 @@ class SecurityHelper */ private function checkInIPv6TrustedList($ip) { - foreach($this->getIPv6TrustedList() as $range) { + foreach ($this->getIPv6TrustedList() as $range) { if ($this->isIPInV6Range($ip, $range)) { return true; } @@ -116,18 +116,18 @@ class SecurityHelper $ip_dec = ip2long($ip); if (strpos($range, '/') === false) { - return ip2long($ip) == ip2long($range); + return ip2long($ip) === ip2long($range); } list($range, $netmask) = explode('/', $range, 2); - list($a,$b,$c,$d) = explode('.', $range); + list($a, $b, $c, $d) = explode('.', $range); $range = sprintf("%u.%u.%u.%u", $a, $b, $c, $d); $range_dec = ip2long($range); - $wildcard_dec = pow(2, (32-$netmask)) - 1; - $netmask_dec = ~ $wildcard_dec; + $wildcard_dec = pow(2, (32 - (int)$netmask)) - 1; + $netmask_dec = ~$wildcard_dec; - return (($ip_dec & $netmask_dec) == ($range_dec & $netmask_dec)); + return (($ip_dec & $netmask_dec) === ($range_dec & $netmask_dec)); } /** @@ -169,7 +169,7 @@ class SecurityHelper /** * Возвращает список диапазонов IPv6 адресов с которых Юkassa может отправлять уведомления * - * @return \string[][] + * @return string[][] */ private function getIPv6TrustedList() { diff --git a/lib/Helpers/StringObject.php b/lib/Helpers/StringObject.php index 3af103d5..a8fa70fb 100644 --- a/lib/Helpers/StringObject.php +++ b/lib/Helpers/StringObject.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Helpers/TypeCast.php b/lib/Helpers/TypeCast.php index 6501d184..ea527e13 100644 --- a/lib/Helpers/TypeCast.php +++ b/lib/Helpers/TypeCast.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Helpers/UUID.php b/lib/Helpers/UUID.php index cc304531..d3fe7ecc 100644 --- a/lib/Helpers/UUID.php +++ b/lib/Helpers/UUID.php @@ -1,7 +1,30 @@ _bookingReference = null; } elseif (!TypeCast::canCastToString($value)) { - throw new InvalidPropertyValueTypeException('Invalid booking reference value type', 0, - 'airline.booking_reference'); + throw new InvalidPropertyValueTypeException( + 'Invalid booking reference value type', + 0, + 'airline.booking_reference' + ); } elseif (mb_strlen((string)$value, 'utf-8') > 20) { - throw new InvalidPropertyValueException('Invalid booking reference value: "'.$value.'"', 0, - 'airline.booking_reference'); + throw new InvalidPropertyValueException( + 'Invalid booking reference value: "' . $value . '"', + 0, + 'airline.booking_reference' + ); } else { $this->_bookingReference = (string)$value; } @@ -111,11 +116,17 @@ class Airline extends AbstractObject implements AirlineInterface if ($value === null || $value === '') { $this->_ticketNumber = null; } elseif (!TypeCast::canCastToString($value)) { - throw new InvalidPropertyValueTypeException('Invalid ticket number value type', 0, - 'airline.ticket_number'); + throw new InvalidPropertyValueTypeException( + 'Invalid ticket number value type', + 0, + 'airline.ticket_number' + ); } elseif (!preg_match('/^[0-9]{1,150}$/', (string)$value)) { - throw new InvalidPropertyValueException('Invalid ticket_number value: "'.$value.'"', 0, - 'airline.ticket_number'); + throw new InvalidPropertyValueException( + 'Invalid ticket_number value: "' . $value . '"', + 0, + 'airline.ticket_number' + ); } else { $this->_ticketNumber = (string)$value; } @@ -140,7 +151,10 @@ class Airline extends AbstractObject implements AirlineInterface } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid passengers value type in airline', 0, 'airline.passengers', $value + 'Invalid passengers value type in airline', + 0, + 'airline.passengers', + $value ); } $this->_passengers = array(); @@ -149,7 +163,10 @@ class Airline extends AbstractObject implements AirlineInterface $this->addPassenger($val); } catch (InvalidPropertyValueTypeException $exception) { throw new InvalidPropertyValueTypeException( - 'Invalid passenger value type in airline', 0, 'airline.passengers['.$key.']', $val + 'Invalid passenger value type in airline', + 0, + 'airline.passengers[' . $key . ']', + $val ); } } @@ -169,7 +186,8 @@ class Airline extends AbstractObject implements AirlineInterface $this->_passengers[] = $passenger; } else { throw new InvalidPropertyValueTypeException( - 'Invalid passenger value type in airline', 0 + 'Invalid passenger value type in airline', + 0 ); } } @@ -193,7 +211,10 @@ class Airline extends AbstractObject implements AirlineInterface } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid legs value type in airline', 0, 'airline.legs', $value + 'Invalid legs value type in airline', + 0, + 'airline.legs', + $value ); } $this->_legs = array(); @@ -202,7 +223,10 @@ class Airline extends AbstractObject implements AirlineInterface $this->addLeg($val); } catch (InvalidPropertyValueTypeException $exception) { throw new InvalidPropertyValueTypeException( - 'Invalid legs value type in airline', 0, 'airline.legs['.$key.']', $val + 'Invalid legs value type in airline', + 0, + 'airline.legs[' . $key . ']', + $val ); } } @@ -222,7 +246,8 @@ class Airline extends AbstractObject implements AirlineInterface $this->_legs[] = $leg; } else { throw new InvalidPropertyValueTypeException( - 'Invalid passenger value type in airline', 0 + 'Invalid passenger value type in airline', + 0 ); } } diff --git a/lib/Model/AirlineInterface.php b/lib/Model/AirlineInterface.php index cbe0460d..6b81e9d7 100644 --- a/lib/Model/AirlineInterface.php +++ b/lib/Model/AirlineInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - interface AirlineInterface { /** diff --git a/lib/Model/AmountInterface.php b/lib/Model/AmountInterface.php index 8ea0e27d..70aab292 100644 --- a/lib/Model/AmountInterface.php +++ b/lib/Model/AmountInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -65,4 +65,10 @@ interface AmountInterface * @param string $value Код валюты */ public function setCurrency($value); + + /** + * Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + * @return array Ассоциативный массив со свойствами текущего объекта + */ + public function toArray(); } diff --git a/lib/Model/AuthorizationDetails.php b/lib/Model/AuthorizationDetails.php index 455cc1bd..8f6a444d 100644 --- a/lib/Model/AuthorizationDetails.php +++ b/lib/Model/AuthorizationDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -33,7 +33,7 @@ use YooKassa\Helpers\TypeCast; /** * AuthorizationDetails - Данные об авторизации платежа * - * @property $rrn Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента + * @property string $rrn Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента * @property string $authCode Код авторизации банковской карты * @property ThreeDSecure $threeDSecure Данные о прохождении пользователем аутентификации по 3‑D Secure */ @@ -115,8 +115,12 @@ class AuthorizationDetails extends AbstractObject implements AuthorizationDetail } elseif (TypeCast::canCastToEnumString($value)) { $this->_rrn = (string)$value; } else { - throw new InvalidPropertyValueTypeException('Invalid rrn value type', 0, - 'authorization_details.rrn', $value); + throw new InvalidPropertyValueTypeException( + 'Invalid rrn value type', + 0, + 'authorization_details.rrn', + $value + ); } } @@ -134,8 +138,12 @@ class AuthorizationDetails extends AbstractObject implements AuthorizationDetail } elseif (TypeCast::canCastToEnumString($value)) { $this->_authCode = (string)$value; } else { - throw new InvalidPropertyValueTypeException('Invalid auth_code value type', 0, - 'authorization_details.auth_code', $value); + throw new InvalidPropertyValueTypeException( + 'Invalid auth_code value type', + 0, + 'authorization_details.auth_code', + $value + ); } } @@ -153,8 +161,12 @@ class AuthorizationDetails extends AbstractObject implements AuthorizationDetail } elseif ($value instanceof ThreeDSecure) { $this->_threeDSecure = $value; } else { - throw new InvalidPropertyValueTypeException('Invalid three_d_secure value type', 0, - 'authorization_details.three_d_secure', $value); + throw new InvalidPropertyValueTypeException( + 'Invalid three_d_secure value type', + 0, + 'authorization_details.three_d_secure', + $value + ); } } } diff --git a/lib/Model/AuthorizationDetailsInterface.php b/lib/Model/AuthorizationDetailsInterface.php index b3d43be3..da14424f 100644 --- a/lib/Model/AuthorizationDetailsInterface.php +++ b/lib/Model/AuthorizationDetailsInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -41,17 +41,17 @@ interface AuthorizationDetailsInterface * Возвращает Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента * @return string|null Уникальный идентификатор транзакции */ - function getRrn(); + public function getRrn(); /** * Возвращает код авторизации банковской карты * @return string|null Код авторизации банковской карты */ - function getAuthCode(); + public function getAuthCode(); /** * Возвращает данные о прохождении пользователем аутентификации по 3‑D Secure * @return ThreeDSecure|null Объект с данными о прохождении пользователем аутентификации по 3‑D Secure */ - function getThreeDSecure(); + public function getThreeDSecure(); } diff --git a/lib/Model/BaseDeal.php b/lib/Model/BaseDeal.php index ac57ff9c..74c58cb8 100644 --- a/lib/Model/BaseDeal.php +++ b/lib/Model/BaseDeal.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -64,7 +64,10 @@ abstract class BaseDeal extends AbstractObject $this->_type = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment type value type', 0, 'BaseDeal.type', $value + 'Invalid payment type value type', + 0, + 'BaseDeal.type', + $value ); } } diff --git a/lib/Model/CancellationDetails.php b/lib/Model/CancellationDetails.php index 90606df5..90514187 100644 --- a/lib/Model/CancellationDetails.php +++ b/lib/Model/CancellationDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/CancellationDetailsInterface.php b/lib/Model/CancellationDetailsInterface.php index e3b553b0..406c4fb8 100644 --- a/lib/Model/CancellationDetailsInterface.php +++ b/lib/Model/CancellationDetailsInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -40,12 +40,11 @@ interface CancellationDetailsInterface * Возвращает участника процесса платежа, который принял решение об отмене транзакции * @return string Участник процесса платежа */ - function getParty(); + public function getParty(); /** * Возвращает причину отмены платежа * @return string Причина отмены платежа */ - function getReason(); - + public function getReason(); } diff --git a/lib/Model/CancellationDetailsPartyCode.php b/lib/Model/CancellationDetailsPartyCode.php index 9e4a7ae3..20328235 100644 --- a/lib/Model/CancellationDetailsPartyCode.php +++ b/lib/Model/CancellationDetailsPartyCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/CancellationDetailsReasonCode.php b/lib/Model/CancellationDetailsReasonCode.php index c6cf1474..ac3f23a0 100644 --- a/lib/Model/CancellationDetailsReasonCode.php +++ b/lib/Model/CancellationDetailsReasonCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Confirmation/AbstractConfirmation.php b/lib/Model/Confirmation/AbstractConfirmation.php index 54eda75c..fe1c80a2 100644 --- a/lib/Model/Confirmation/AbstractConfirmation.php +++ b/lib/Model/Confirmation/AbstractConfirmation.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -67,19 +67,27 @@ abstract class AbstractConfirmation extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "type" parameter in Confirmation', 0, 'confirmation.type' + 'Empty value for "type" parameter in Confirmation', + 0, + 'confirmation.type' ); } elseif (TypeCast::canCastToEnumString($value)) { if (ConfirmationType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Confirmation', 0, 'confirmation.type', $value + 'Invalid value for "type" parameter in Confirmation', + 0, + 'confirmation.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in Confirmation', 0, 'confirmation.type', $value + 'Invalid value type for "type" parameter in Confirmation', + 0, + 'confirmation.type', + $value ); } } diff --git a/lib/Model/Confirmation/ConfirmationCodeVerification.php b/lib/Model/Confirmation/ConfirmationCodeVerification.php index dde52fe9..afdab7d4 100644 --- a/lib/Model/Confirmation/ConfirmationCodeVerification.php +++ b/lib/Model/Confirmation/ConfirmationCodeVerification.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Confirmation/ConfirmationEmbedded.php b/lib/Model/Confirmation/ConfirmationEmbedded.php index bae89093..72e73686 100644 --- a/lib/Model/Confirmation/ConfirmationEmbedded.php +++ b/lib/Model/Confirmation/ConfirmationEmbedded.php @@ -1,8 +1,9 @@ confirmationToken = (string)$confirmationToken; } else { throw new InvalidPropertyValueTypeException( - 'Invalid confirmationToken value type', 0, 'confirmationEmbedded.confirmationToken', $confirmationToken + 'Invalid confirmationToken value type', + 0, + 'confirmationEmbedded.confirmationToken', + $confirmationToken ); } } diff --git a/lib/Model/Confirmation/ConfirmationExternal.php b/lib/Model/Confirmation/ConfirmationExternal.php index 20132b6d..1e552e8d 100644 --- a/lib/Model/Confirmation/ConfirmationExternal.php +++ b/lib/Model/Confirmation/ConfirmationExternal.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Confirmation/ConfirmationFactory.php b/lib/Model/Confirmation/ConfirmationFactory.php index 7c1850d5..775922d3 100644 --- a/lib/Model/Confirmation/ConfirmationFactory.php +++ b/lib/Model/Confirmation/ConfirmationFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -57,9 +57,9 @@ class ConfirmationFactory throw new \InvalidArgumentException('Invalid confirmation value in confirmation factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid confirmation value type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid confirmation value type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } diff --git a/lib/Model/Confirmation/ConfirmationMobileApplication.php b/lib/Model/Confirmation/ConfirmationMobileApplication.php index 26a5c192..4afbceed 100644 --- a/lib/Model/Confirmation/ConfirmationMobileApplication.php +++ b/lib/Model/Confirmation/ConfirmationMobileApplication.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -77,7 +77,10 @@ class ConfirmationMobileApplication extends AbstractConfirmation $this->_returnUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid returnUrl value type', 0, 'ConfirmationMobileApplication.returnUrl', $value + 'Invalid returnUrl value type', + 0, + 'ConfirmationMobileApplication.returnUrl', + $value ); } } @@ -102,7 +105,10 @@ class ConfirmationMobileApplication extends AbstractConfirmation $this->_confirmationUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid confirmationUrl value type', 0, 'ConfirmationMobileApplication.confirmationUrl', $value + 'Invalid confirmationUrl value type', + 0, + 'ConfirmationMobileApplication.confirmationUrl', + $value ); } } diff --git a/lib/Model/Confirmation/ConfirmationQr.php b/lib/Model/Confirmation/ConfirmationQr.php index d0c899c2..2a0913ed 100644 --- a/lib/Model/Confirmation/ConfirmationQr.php +++ b/lib/Model/Confirmation/ConfirmationQr.php @@ -1,8 +1,9 @@ _confirmationData = (string)$confirmationData; } else { throw new InvalidPropertyValueTypeException( - 'Invalid confirmationData value type', 0, 'confirmationQr.confirmationData', $confirmationData + 'Invalid confirmationData value type', + 0, + 'confirmationQr.confirmationData', + $confirmationData ); } } diff --git a/lib/Model/Confirmation/ConfirmationRedirect.php b/lib/Model/Confirmation/ConfirmationRedirect.php index 03e8d3d1..1c268943 100644 --- a/lib/Model/Confirmation/ConfirmationRedirect.php +++ b/lib/Model/Confirmation/ConfirmationRedirect.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -85,7 +85,10 @@ class ConfirmationRedirect extends AbstractConfirmation $this->_enforce = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid enforce value type', 0, 'confirmationRedirect.enforce', $value + 'Invalid enforce value type', + 0, + 'confirmationRedirect.enforce', + $value ); } } @@ -110,7 +113,10 @@ class ConfirmationRedirect extends AbstractConfirmation $this->_returnUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid returnUrl value type', 0, 'confirmationRedirect.returnUrl', $value + 'Invalid returnUrl value type', + 0, + 'confirmationRedirect.returnUrl', + $value ); } } @@ -134,7 +140,10 @@ class ConfirmationRedirect extends AbstractConfirmation $this->_confirmationUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid confirmationUrl value type', 0, 'confirmationRedirect.confirmationUrl', $value + 'Invalid confirmationUrl value type', + 0, + 'confirmationRedirect.confirmationUrl', + $value ); } } diff --git a/lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php b/lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php index 33e3ad62..7db2e46e 100644 --- a/lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php +++ b/lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -61,23 +61,32 @@ abstract class AbstractConfirmationAttributes extends AbstractObject /** * @param string $value */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "type" parameter in ConfirmationAttributes', 0, 'confirmationAttributes.type' + 'Empty value for "type" parameter in ConfirmationAttributes', + 0, + 'confirmationAttributes.type' ); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (ConfirmationType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in ConfirmationAttributes', 0, 'confirmationAttributes.type', $value + 'Invalid value for "type" parameter in ConfirmationAttributes', + 0, + 'confirmationAttributes.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in ConfirmationAttributes', 0, 'confirmationAttributes.type', $value + 'Invalid value type for "type" parameter in ConfirmationAttributes', + 0, + 'confirmationAttributes.type', + $value ); } } @@ -99,11 +108,17 @@ abstract class AbstractConfirmationAttributes extends AbstractObject $this->_locale = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "locale" parameter in ConfirmationAttributes', 0, 'confirmationAttributes.locale', $value + 'Invalid value type for "locale" parameter in ConfirmationAttributes', + 0, + 'confirmationAttributes.locale', + $value ); } elseif (!preg_match('/^[a-z]{2}_[A-Z]{2}$/', (string)$value)) { throw new InvalidPropertyValueException( - 'Invalid value type for "locale" parameter in ConfirmationAttributes', 0, 'confirmationAttributes.locale', $value + 'Invalid value type for "locale" parameter in ConfirmationAttributes', + 0, + 'confirmationAttributes.locale', + $value ); } else { $this->_locale = (string)$value; diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php index 3a61bfa8..c3248401 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class ConfirmationAttributesCodeVerification extends AbstractConfirmationAttribu { public function __construct() { - $this->_setType(ConfirmationType::CODE_VERIFICATION); + $this->setType(ConfirmationType::CODE_VERIFICATION); } } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php index f3eb16de..564f9987 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php @@ -1,8 +1,9 @@ _setType(ConfirmationType::EMBEDDED); + $this->setType(ConfirmationType::EMBEDDED); } } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php index b6cda8dd..f76eb7f2 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -38,6 +38,6 @@ class ConfirmationAttributesExternal extends AbstractConfirmationAttributes { public function __construct() { - $this->_setType(ConfirmationType::EXTERNAL); + $this->setType(ConfirmationType::EXTERNAL); } } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php index 45b3dd36..d98d49dc 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -55,9 +55,9 @@ class ConfirmationAttributesFactory throw new \InvalidArgumentException('Invalid confirmation attributes value in confirmation factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid confirmation attributes value type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid confirmation attributes value type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php index bb61d8b8..96cfa96d 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesMobileApplication.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -44,7 +44,7 @@ class ConfirmationAttributesMobileApplication extends AbstractConfirmationAttrib public function __construct($data = array()) { parent::__construct($data); - $this->_setType(ConfirmationType::MOBILE_APPLICATION); + $this->setType(ConfirmationType::MOBILE_APPLICATION); } /** @@ -67,7 +67,10 @@ class ConfirmationAttributesMobileApplication extends AbstractConfirmationAttrib $this->_returnUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid returnUrl value type', 0, 'ConfirmationAttributesMobileApplication.returnUrl', $value + 'Invalid returnUrl value type', + 0, + 'ConfirmationAttributesMobileApplication.returnUrl', + $value ); } } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php index ada55835..c4e0d255 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php @@ -1,8 +1,9 @@ _setType(ConfirmationType::QR); + $this->setType(ConfirmationType::QR); } } diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php index 68bbc7c3..d43c7e27 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -51,7 +51,7 @@ class ConfirmationAttributesRedirect extends AbstractConfirmationAttributes public function __construct() { - $this->_setType(ConfirmationType::REDIRECT); + $this->setType(ConfirmationType::REDIRECT); } /** @@ -75,7 +75,10 @@ class ConfirmationAttributesRedirect extends AbstractConfirmationAttributes $this->_enforce = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid enforce value type', 0, 'confirmationAttributesRedirect.enforce', $value + 'Invalid enforce value type', + 0, + 'confirmationAttributesRedirect.enforce', + $value ); } } @@ -100,7 +103,10 @@ class ConfirmationAttributesRedirect extends AbstractConfirmationAttributes $this->_returnUrl = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid returnUrl value type', 0, 'confirmationAttributesRedirect.returnUrl', $value + 'Invalid returnUrl value type', + 0, + 'confirmationAttributesRedirect.returnUrl', + $value ); } } diff --git a/lib/Model/ConfirmationType.php b/lib/Model/ConfirmationType.php index 63a92b99..60d89738 100644 --- a/lib/Model/ConfirmationType.php +++ b/lib/Model/ConfirmationType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,22 +30,31 @@ use YooKassa\Common\AbstractEnum; /** * ConfirmationType - Тип пользовательского процесса подтверждения платежа - * |Код|Описание| - * --- | --- - * |redirect|Необходимо направить плательщика на страницу партнера| - * |external|Необходимо ождать пока плательщик самостоятельно подтвердит платеж| - * |code_verification|Необходимо получить одноразовый код от плательщика для подтверждения платежа| - * |embedded|Необходимо получить токен для checkout.js| - * |qr|Необходимо получить QR-код| - * |mobile_application|необходимо совершить действия в мобильном приложении| + * + * Возможные значения: + * - `redirect` - Необходимо направить плательщика на страницу партнера + * - `external` - Для подтверждения платежа пользователю необходимо совершить действия во внешней системе (например, ответить на смс) + * - `code_verification` - Необходимо получить одноразовый код от плательщика для подтверждения платежа + * - `embedded` - Необходимо получить токен для checkout.js + * - `qr` - Необходимо получить QR-код + * - `mobile_application` - Необходимо совершить действия в мобильном приложении */ class ConfirmationType extends AbstractEnum { - const REDIRECT = 'redirect'; - const EXTERNAL = 'external'; - const CODE_VERIFICATION = 'code_verification'; - const EMBEDDED = 'embedded'; - const QR = 'qr'; + /** Необходимо направить плательщика на страницу партнера */ + const REDIRECT = 'redirect'; + /** Для подтверждения платежа пользователю необходимо совершить действия во внешней системе (например, ответить на смс) */ + const EXTERNAL = 'external'; + /** + * Необходимо ждать пока плательщик самостоятельно подтвердит платеж + * @deprecated Будет удален в будущих версиях + */ + const CODE_VERIFICATION = 'code_verification'; + /** Необходимо получить одноразовый код от плательщика для подтверждения платежа */ + const EMBEDDED = 'embedded'; + /** Необходимо получить QR-код */ + const QR = 'qr'; + /** Необходимо совершить действия в мобильном приложении */ const MOBILE_APPLICATION = 'mobile_application'; protected static $validValues = array( diff --git a/lib/Model/CurrencyCode.php b/lib/Model/CurrencyCode.php index 29f872f8..c0a525d6 100644 --- a/lib/Model/CurrencyCode.php +++ b/lib/Model/CurrencyCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -29,7 +29,12 @@ namespace YooKassa\Model; use YooKassa\Common\AbstractEnum; /** - * CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol + * CurrencyCode - Код валюты в формате [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html). + * Должен соответствовать валюте субаккаунта (`recipient.gateway_id`), если вы разделяете потоки платежей, + * и валюте аккаунта (shopId в [личном кабинете](https://yookassa.ru/my)), если не разделяете. + * + * @package YooKassa\Model + * @author cms@yoomoney.ru */ class CurrencyCode extends AbstractEnum { @@ -47,6 +52,16 @@ class CurrencyCode extends AbstractEnum const KZT = 'KZT'; /** Украинская гривна */ const UAH = 'UAH'; + /** Узбекский сум */ + const UZS = 'UZS'; + /** Турецкая лира */ + const _TRY = 'TRY'; + /** Индийская рупия */ + const INR = 'INR'; + /** Молдавский лей */ + const MDL = 'MDL'; + /** Азербайджанский манат */ + const AZN = 'AZN'; protected static $validValues = array( self::RUB => true, @@ -56,5 +71,10 @@ class CurrencyCode extends AbstractEnum self::CNY => true, self::KZT => true, self::UAH => true, + self::UZS => true, + self::_TRY => true, + self::INR => true, + self::MDL => true, + self::AZN => true, ); } diff --git a/lib/Model/Deal/CaptureDealData.php b/lib/Model/Deal/CaptureDealData.php index bbac0bc0..6d4116d9 100644 --- a/lib/Model/Deal/CaptureDealData.php +++ b/lib/Model/Deal/CaptureDealData.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -65,7 +65,10 @@ class CaptureDealData extends AbstractObject } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements', $value + 'Invalid settlements value type in deal', + 0, + 'deal.settlements', + $value ); } $this->_settlements = array(); @@ -76,7 +79,10 @@ class CaptureDealData extends AbstractObject $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements['.$key.']', $val + 'Invalid settlements value type in deal', + 0, + 'deal.settlements[' . $key . ']', + $val ); } } diff --git a/lib/Model/Deal/DealBalanceAmount.php b/lib/Model/Deal/DealBalanceAmount.php index 19aeda9b..1d4e7c1b 100644 --- a/lib/Model/Deal/DealBalanceAmount.php +++ b/lib/Model/Deal/DealBalanceAmount.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -147,7 +147,10 @@ class DealBalanceAmount extends AbstractObject implements AmountInterface $this->_currency = $value; } else { throw new InvalidPropertyValueException( - 'Invalid currency value: "' . $value . '"', 0, 'amount.currency', $value + 'Invalid currency value: "' . $value . '"', + 0, + 'amount.currency', + $value ); } } else { diff --git a/lib/Model/Deal/DealStatus.php b/lib/Model/Deal/DealStatus.php index 02f5dd32..21149621 100644 --- a/lib/Model/Deal/DealStatus.php +++ b/lib/Model/Deal/DealStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Deal/DealType.php b/lib/Model/Deal/DealType.php index cbad6bc7..2b39b693 100644 --- a/lib/Model/Deal/DealType.php +++ b/lib/Model/Deal/DealType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Deal/FeeMoment.php b/lib/Model/Deal/FeeMoment.php index f9402691..5ef8e818 100644 --- a/lib/Model/Deal/FeeMoment.php +++ b/lib/Model/Deal/FeeMoment.php @@ -1,5 +1,29 @@ true, self::DEAL_CLOSED => true, ); -} \ No newline at end of file +} diff --git a/lib/Model/Deal/PaymentDealInfo.php b/lib/Model/Deal/PaymentDealInfo.php index 6c84e445..42a1a666 100644 --- a/lib/Model/Deal/PaymentDealInfo.php +++ b/lib/Model/Deal/PaymentDealInfo.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -89,7 +89,10 @@ class PaymentDealInfo extends AbstractObject } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements', $value + 'Invalid settlements value type in deal', + 0, + 'deal.settlements', + $value ); } $this->_settlements = array(); @@ -100,7 +103,10 @@ class PaymentDealInfo extends AbstractObject $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements['.$key.']', $val + 'Invalid settlements value type in deal', + 0, + 'deal.settlements[' . $key . ']', + $val ); } } diff --git a/lib/Model/Deal/PayoutDealInfo.php b/lib/Model/Deal/PayoutDealInfo.php index 523f5701..6039f5a3 100644 --- a/lib/Model/Deal/PayoutDealInfo.php +++ b/lib/Model/Deal/PayoutDealInfo.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Deal/RefundDealData.php b/lib/Model/Deal/RefundDealData.php index 1b69f0dc..aec2ea21 100644 --- a/lib/Model/Deal/RefundDealData.php +++ b/lib/Model/Deal/RefundDealData.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -41,7 +41,6 @@ use YooKassa\Model\SettlementInterface; */ class RefundDealData extends AbstractObject { - /** @var SettlementPayoutRefund[] Данные о распределении денег */ private $_refund_settlements = array(); @@ -68,7 +67,10 @@ class RefundDealData extends AbstractObject } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid refund_settlements value type in deal', 0, 'deal.refund_settlements', $value + 'Invalid refund_settlements value type in deal', + 0, + 'deal.refund_settlements', + $value ); } $this->_refund_settlements = array(); @@ -79,7 +81,10 @@ class RefundDealData extends AbstractObject $this->addRefundSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid refund_settlements value type in deal', 0, 'deal.refund_settlements['.$key.']', $val + 'Invalid refund_settlements value type in deal', + 0, + 'deal.refund_settlements[' . $key . ']', + $val ); } } diff --git a/lib/Model/Deal/RefundDealInfo.php b/lib/Model/Deal/RefundDealInfo.php index 6ae416ed..2f7d7bb8 100644 --- a/lib/Model/Deal/RefundDealInfo.php +++ b/lib/Model/Deal/RefundDealInfo.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -91,7 +91,10 @@ class RefundDealInfo extends AbstractObject } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements', $value + 'Invalid settlements value type in deal', + 0, + 'deal.settlements', + $value ); } $this->_refund_settlements = array(); @@ -102,7 +105,10 @@ class RefundDealInfo extends AbstractObject $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in deal', 0, 'deal.settlements['.$key.']', $val + 'Invalid settlements value type in deal', + 0, + 'deal.settlements[' . $key . ']', + $val ); } } diff --git a/lib/Model/Deal/SettlementPayoutPayment.php b/lib/Model/Deal/SettlementPayoutPayment.php index d6881c5c..056a0f5a 100644 --- a/lib/Model/Deal/SettlementPayoutPayment.php +++ b/lib/Model/Deal/SettlementPayoutPayment.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model\Deal; - use YooKassa\Common\AbstractObject; use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; @@ -72,19 +71,27 @@ class SettlementPayoutPayment extends AbstractObject implements SettlementInterf { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "type" parameter in Settlement', 0, 'settlement.type' + 'Empty value for "type" parameter in Settlement', + 0, + 'settlement.type' ); } elseif (TypeCast::canCastToEnumString($value)) { if (SettlementPayoutPaymentType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value type for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } @@ -106,7 +113,9 @@ class SettlementPayoutPayment extends AbstractObject implements SettlementInterf { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "amount" parameter in Settlement', 0, 'settlement.amount' + 'Empty value for "amount" parameter in Settlement', + 0, + 'settlement.amount' ); } elseif (is_array($value)) { $this->_amount = $this->factoryAmount($value); @@ -114,7 +123,10 @@ class SettlementPayoutPayment extends AbstractObject implements SettlementInterf $this->_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "amount" parameter in Settlement', 0, 'settlement.amount', $value + 'Invalid value type for "amount" parameter in Settlement', + 0, + 'settlement.amount', + $value ); } } diff --git a/lib/Model/Deal/SettlementPayoutPaymentType.php b/lib/Model/Deal/SettlementPayoutPaymentType.php index 00f20ed2..5d790dc8 100644 --- a/lib/Model/Deal/SettlementPayoutPaymentType.php +++ b/lib/Model/Deal/SettlementPayoutPaymentType.php @@ -1,8 +1,9 @@ _type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value type for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } @@ -107,7 +114,9 @@ class SettlementPayoutRefund extends AbstractObject implements SettlementInterfa { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "amount" parameter in Settlement', 0, 'settlement.amount' + 'Empty value for "amount" parameter in Settlement', + 0, + 'settlement.amount' ); } elseif (is_array($value)) { $this->_amount = $this->factoryAmount($value); @@ -115,7 +124,10 @@ class SettlementPayoutRefund extends AbstractObject implements SettlementInterfa $this->_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "amount" parameter in Settlement', 0, 'settlement.amount', $value + 'Invalid value type for "amount" parameter in Settlement', + 0, + 'settlement.amount', + $value ); } } diff --git a/lib/Model/DealInterface.php b/lib/Model/DealInterface.php index f40910dd..522f9306 100644 --- a/lib/Model/DealInterface.php +++ b/lib/Model/DealInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/FraudData.php b/lib/Model/FraudData.php new file mode 100644 index 00000000..2af81ebb --- /dev/null +++ b/lib/Model/FraudData.php @@ -0,0 +1,98 @@ +_topped_up_phone; + } + + /** + * Устанавливает номер телефона для пополнения. + * + * @param string|null $topped_up_phone Номер телефона для пополнения + * + * @return FraudData + */ + public function setToppedUpPhone($topped_up_phone = null) + { + if ($topped_up_phone === null || $topped_up_phone === '') { + $this->_topped_up_phone = null; + } elseif (TypeCast::canCastToString($topped_up_phone)) { + $value = preg_replace('/\D/', '', $topped_up_phone); + if (mb_strlen($value, 'utf-8') > 15) { + throw new InvalidPropertyValueException( + 'Invalid FraudData topped_up_phone value', + 0, + 'FraudData.topped_up_phone', + $value + ); + } + $this->_topped_up_phone = (string)$value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid topped_up_phone topped_up_phone type in FraudData', + 0, + 'FraudData.topped_up_phone', + $topped_up_phone + ); + } + + return $this; + } +} diff --git a/lib/Model/Leg.php b/lib/Model/Leg.php index 824e0230..1760b376 100644 --- a/lib/Model/Leg.php +++ b/lib/Model/Leg.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - use YooKassa\Common\AbstractObject; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -81,11 +80,17 @@ class Leg extends AbstractObject implements LegInterface public function setDepartureAirport($value) { if (!TypeCast::canCastToString($value)) { - throw new InvalidPropertyValueTypeException('Invalid departure_airport value type', 0, - 'airline.departure_airport'); + throw new InvalidPropertyValueTypeException( + 'Invalid departure_airport value type', + 0, + 'airline.departure_airport' + ); } elseif (!preg_match('/^[A-Z]{3}$/', (string)$value)) { - throw new InvalidPropertyValueException('Invalid departure_airport value: "'.$value.'"', 0, - 'airline.departure_airport'); + throw new InvalidPropertyValueException( + 'Invalid departure_airport value: "' . $value . '"', + 0, + 'airline.departure_airport' + ); } else { $this->_departureAirport = (string)$value; } @@ -106,11 +111,17 @@ class Leg extends AbstractObject implements LegInterface public function setDestinationAirport($value) { if (!TypeCast::canCastToString($value)) { - throw new InvalidPropertyValueTypeException('Invalid destination_airport value type', 0, - 'airline.destination_airport'); + throw new InvalidPropertyValueTypeException( + 'Invalid destination_airport value type', + 0, + 'airline.destination_airport' + ); } elseif (!preg_match('/^[A-Z]{3}$/', (string)$value)) { - throw new InvalidPropertyValueException('Invalid destination_airport value: "'.$value.'"', 0, - 'airline.destination_airport'); + throw new InvalidPropertyValueException( + 'Invalid destination_airport value: "' . $value . '"', + 0, + 'airline.destination_airport' + ); } else { $this->_destinationAirport = (string)$value; } @@ -135,13 +146,17 @@ class Leg extends AbstractObject implements LegInterface $departureDate = TypeCast::castToDateTime($value); if ($departureDate === null) { throw new InvalidPropertyValueException( - 'Invalid departure_date value in airline.legs', 0, 'airline.legs' + 'Invalid departure_date value in airline.legs', + 0, + 'airline.legs' ); } $this->_departureDate = $departureDate->format(self::ISO8601); } else { throw new InvalidPropertyValueTypeException( - 'Invalid departure_date value type in airline.legs', 0, 'airline.legs' + 'Invalid departure_date value type in airline.legs', + 0, + 'airline.legs' ); } } diff --git a/lib/Model/LegInterface.php b/lib/Model/LegInterface.php index 3e65f3b3..f48c6af7 100644 --- a/lib/Model/LegInterface.php +++ b/lib/Model/LegInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Locale.php b/lib/Model/Locale.php index 18879f00..4c7ae81e 100644 --- a/lib/Model/Locale.php +++ b/lib/Model/Locale.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,14 +30,16 @@ use YooKassa\Common\AbstractEnum; /** * Locale - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь - * |Код|Описание| - * --- | --- - * |ru_RU|Русский| - * |en_US|English| + * + * Возможные значения: + * - `ru_RU` - Русский + * - `en_US` - English */ class Locale extends AbstractEnum { + /** Русский */ const RUSSIAN = 'ru_RU'; + /** English */ const ENGLISH = 'en_US'; protected static $validValues = array( diff --git a/lib/Model/Metadata.php b/lib/Model/Metadata.php index d30261a4..d165b521 100644 --- a/lib/Model/Metadata.php +++ b/lib/Model/Metadata.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/MonetaryAmount.php b/lib/Model/MonetaryAmount.php index 822f6977..c9c87c95 100644 --- a/lib/Model/MonetaryAmount.php +++ b/lib/Model/MonetaryAmount.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -103,11 +103,11 @@ class MonetaryAmount extends AbstractObject implements AmountInterface throw new InvalidPropertyValueTypeException('Invalid amount value type', 0, 'amount.value', $value); } if ($value <= 0.0) { - throw new InvalidPropertyValueException('Invalid amount value: "'.$value.'"', 0, 'amount.value', $value); + throw new InvalidPropertyValueException('Invalid amount value: "' . $value . '"', 0, 'amount.value', $value); } $castedValue = (int)round($value * 100.0); if ($castedValue <= 0.0) { - throw new InvalidPropertyValueException('Invalid amount value: "'.$value.'"', 0, 'amount.value', $value); + throw new InvalidPropertyValueException('Invalid amount value: "' . $value . '"', 0, 'amount.value', $value); } $this->_value = $castedValue; } @@ -149,7 +149,10 @@ class MonetaryAmount extends AbstractObject implements AmountInterface $this->_currency = $value; } else { throw new InvalidPropertyValueException( - 'Invalid currency value: "' . $value . '"', 0, 'amount.currency', $value + 'Invalid currency value: "' . $value . '"', + 0, + 'amount.currency', + $value ); } } else { @@ -173,18 +176,27 @@ class MonetaryAmount extends AbstractObject implements AmountInterface } if (!is_numeric($coefficient)) { throw new InvalidPropertyValueTypeException( - 'Invalid coefficient type in multiply method', 0, 'amount.value', $coefficient + 'Invalid coefficient type in multiply method', + 0, + 'amount.value', + $coefficient ); } if ($coefficient <= 0.0) { throw new InvalidPropertyValueException( - 'Invalid coefficient in multiply method: "' . $coefficient . '"', 0, 'amount.value', $coefficient + 'Invalid coefficient in multiply method: "' . $coefficient . '"', + 0, + 'amount.value', + $coefficient ); } $castedValue = (int)round($coefficient * $this->_value); if ($castedValue === 0) { throw new InvalidPropertyValueException( - 'Invalid coefficient value in multiply method: "' . $coefficient . '"', 0, 'amount.value', $coefficient + 'Invalid coefficient value in multiply method: "' . $coefficient . '"', + 0, + 'amount.value', + $coefficient ); } $this->_value = $castedValue; @@ -205,13 +217,19 @@ class MonetaryAmount extends AbstractObject implements AmountInterface } if (!is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid amount value type in increase method', 0, 'amount.value', $value + 'Invalid amount value type in increase method', + 0, + 'amount.value', + $value ); } $castedValue = (int)round($this->_value + $value * 100.0); if ($castedValue <= 0) { throw new InvalidPropertyValueException( - 'Invalid amount value in increase method: "' . $value . '"', 0, 'amount.value', $value + 'Invalid amount value in increase method: "' . $value . '"', + 0, + 'amount.value', + $value ); } $this->_value = $castedValue; diff --git a/lib/Model/Notification/AbstractNotification.php b/lib/Model/Notification/AbstractNotification.php index d7297b99..6ee256e5 100644 --- a/lib/Model/Notification/AbstractNotification.php +++ b/lib/Model/Notification/AbstractNotification.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -80,21 +80,28 @@ abstract class AbstractNotification extends AbstractObject implements Notificati * нотификаций * @throws InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException('Empty parameter "type" in Notification', 0, 'notification.type'); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (NotificationType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $value + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in Notification', 0, 'notification.type', $value + 'Invalid value type for "type" parameter in Notification', + 0, + 'notification.type', + $value ); } } @@ -121,21 +128,28 @@ abstract class AbstractNotification extends AbstractObject implements Notificati * событий * @throws InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой */ - protected function _setEvent($value) + protected function setEvent($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException('Empty parameter "event" in Notification', 0, 'notification.event'); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (NotificationEventType::valueExists($value)) { $this->_event = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $value + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "event" parameter in Notification', 0, 'notification.event', $value + 'Invalid value type for "event" parameter in Notification', + 0, + 'notification.event', + $value ); } } diff --git a/lib/Model/Notification/NotificationCanceled.php b/lib/Model/Notification/NotificationCanceled.php index b6a958a1..a0a1fbee 100644 --- a/lib/Model/Notification/NotificationCanceled.php +++ b/lib/Model/Notification/NotificationCanceled.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model\Notification; - use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Model\NotificationEventType; @@ -62,34 +61,40 @@ class NotificationCanceled extends AbstractNotification * тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если * передать уведомление не того типа, будет сгенерировано исключение типа {@link InvalidPropertyValueException} * - * @param array $source Ассоциативный массив с информацией об уведомлении + * @param array $sourceArray Ассоциативный массив с информацией об уведомлении * * @throws InvalidPropertyValueException Генерируется если значение типа нотификации или события не равны * "notification" и "payment.canceled" соответственно, что может говорить о том, что переданные в * конструктор данные не являются уведомлением нужного типа. */ - public function fromArray($source) + public function fromArray($sourceArray) { - $this->_setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::PAYMENT_CANCELED); - if (!empty($source['type'])) { - if ($this->getType() !== $source['type']) { + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::PAYMENT_CANCELED); + if (!empty($sourceArray['type'])) { + if ($this->getType() !== $sourceArray['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $sourceArray['type'] ); } } - if (!empty($source['event'])) { - if ($this->getEvent() !== $source['event']) { + if (!empty($sourceArray['event'])) { + if ($this->getEvent() !== $sourceArray['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $sourceArray['event'] ); } } - if (empty($source['object'])) { + if (empty($sourceArray['object'])) { throw new EmptyPropertyValueException('Parameter object in NotificationCanceled is empty'); } - $this->_object = new PaymentResponse($source['object']); + $this->_object = new PaymentResponse($sourceArray['object']); } /** diff --git a/lib/Model/Notification/NotificationDealClosed.php b/lib/Model/Notification/NotificationDealClosed.php index f0c91b4b..ba6bc39d 100644 --- a/lib/Model/Notification/NotificationDealClosed.php +++ b/lib/Model/Notification/NotificationDealClosed.php @@ -1,8 +1,9 @@ _setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::DEAL_CLOSED); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::DEAL_CLOSED); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/Notification/NotificationFactory.php b/lib/Model/Notification/NotificationFactory.php index c0276385..3768bae2 100644 --- a/lib/Model/Notification/NotificationFactory.php +++ b/lib/Model/Notification/NotificationFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -70,5 +70,4 @@ class NotificationFactory return new $className($data); } - } diff --git a/lib/Model/Notification/NotificationInterface.php b/lib/Model/Notification/NotificationInterface.php index ebf80ae0..ef373e4b 100644 --- a/lib/Model/Notification/NotificationInterface.php +++ b/lib/Model/Notification/NotificationInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model\Notification; - use YooKassa\Model\PaymentInterface; use YooKassa\Model\RefundInterface; @@ -39,7 +38,7 @@ interface NotificationInterface * * @return string Тип уведомления в виде строки */ - function getType(); + public function getType(); /** * Возвращает тип события @@ -48,7 +47,7 @@ interface NotificationInterface * * @return string Тип события */ - function getEvent(); + public function getEvent(); /** * Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте @@ -59,5 +58,5 @@ interface NotificationInterface * * @return PaymentInterface|RefundInterface Объект с информацией о платеже */ - function getObject(); + public function getObject(); } diff --git a/lib/Model/Notification/NotificationPayoutCanceled.php b/lib/Model/Notification/NotificationPayoutCanceled.php index bf3c85cb..e22b3168 100644 --- a/lib/Model/Notification/NotificationPayoutCanceled.php +++ b/lib/Model/Notification/NotificationPayoutCanceled.php @@ -1,8 +1,9 @@ _setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::PAYOUT_CANCELED); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::PAYOUT_CANCELED); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/Notification/NotificationPayoutSucceeded.php b/lib/Model/Notification/NotificationPayoutSucceeded.php index b359cb2f..7c763eb3 100644 --- a/lib/Model/Notification/NotificationPayoutSucceeded.php +++ b/lib/Model/Notification/NotificationPayoutSucceeded.php @@ -1,8 +1,9 @@ _setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::PAYOUT_SUCCEEDED); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::PAYOUT_SUCCEEDED); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/Notification/NotificationRefundSucceeded.php b/lib/Model/Notification/NotificationRefundSucceeded.php index f77976bd..1641ece4 100644 --- a/lib/Model/Notification/NotificationRefundSucceeded.php +++ b/lib/Model/Notification/NotificationRefundSucceeded.php @@ -1,8 +1,9 @@ _setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::REFUND_SUCCEEDED); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::REFUND_SUCCEEDED); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/Notification/NotificationSucceeded.php b/lib/Model/Notification/NotificationSucceeded.php index 7acf3943..73280305 100644 --- a/lib/Model/Notification/NotificationSucceeded.php +++ b/lib/Model/Notification/NotificationSucceeded.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -69,19 +69,25 @@ class NotificationSucceeded extends AbstractNotification */ public function __construct(array $source) { - $this->_setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::PAYMENT_SUCCEEDED); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::PAYMENT_SUCCEEDED); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/Notification/NotificationWaitingForCapture.php b/lib/Model/Notification/NotificationWaitingForCapture.php index bf216734..db6c98af 100644 --- a/lib/Model/Notification/NotificationWaitingForCapture.php +++ b/lib/Model/Notification/NotificationWaitingForCapture.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -73,19 +73,25 @@ class NotificationWaitingForCapture extends AbstractNotification */ public function __construct(array $source) { - $this->_setType(NotificationType::NOTIFICATION); - $this->_setEvent(NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE); + $this->setType(NotificationType::NOTIFICATION); + $this->setEvent(NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE); if (!empty($source['type'])) { if ($this->getType() !== $source['type']) { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type'] + 'Invalid value for "type" parameter in Notification', + 0, + 'notification.type', + $source['type'] ); } } if (!empty($source['event'])) { if ($this->getEvent() !== $source['event']) { throw new InvalidPropertyValueException( - 'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event'] + 'Invalid value for "event" parameter in Notification', + 0, + 'notification.event', + $source['event'] ); } } diff --git a/lib/Model/NotificationEventType.php b/lib/Model/NotificationEventType.php index ce44eba2..0ab85fa6 100644 --- a/lib/Model/NotificationEventType.php +++ b/lib/Model/NotificationEventType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,15 +30,15 @@ use YooKassa\Common\AbstractEnum; /** * NotificationEventType - Тип уведомления - * |Код|Описание| - * --- | --- - * |payment.waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| - * |payment.succeeded|Успешно оплачен и подтвержден магазином| - * |payment.canceled|Неуспех оплаты или отменен магазином| - * |refund.succeeded|Успешный возврат| - * |deal.closed|Сделка перешла в статус closed| - * |payout.canceled|Выплата перешла в статус canceled| - * |payout.succeeded|Выплата перешла в статус succeeded| + * + * Возможные значения: + * - `payment.waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) + * - `payment.succeeded` - Успешно оплачен и подтвержден магазином + * - `payment.canceled` - Неуспех оплаты или отменен магазином + * - `refund.succeeded` - Успешный возврат + * - `deal.closed` - Сделка перешла в статус closed + * - `payout.canceled` - Выплата перешла в статус canceled + * - `payout.succeeded` - Выплата перешла в статус succeeded * * @package YooKassa */ diff --git a/lib/Model/NotificationType.php b/lib/Model/NotificationType.php index 287415fe..21947ec0 100644 --- a/lib/Model/NotificationType.php +++ b/lib/Model/NotificationType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Passenger.php b/lib/Model/Passenger.php index d0291d12..7c2830e9 100644 --- a/lib/Model/Passenger.php +++ b/lib/Model/Passenger.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - use YooKassa\Common\AbstractObject; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -70,20 +69,28 @@ class Passenger extends AbstractObject implements PassengerInterface { if (empty($value) || is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid first_name value type in Passenger object', 0, 'airline.passengers', $value + 'Invalid first_name value type in Passenger object', + 0, + 'airline.passengers', + $value ); - } else if (TypeCast::canCastToString($value)) { + } elseif (TypeCast::canCastToString($value)) { $length = mb_strlen((string)$value, 'utf-8'); if ($length > 64) { throw new InvalidPropertyValueException( 'Invalid first_name value length in Passenger object', - 0, 'airline.passengers', $value + 0, + 'airline.passengers', + $value ); } $this->_firstName = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid first_name value type in Passenger object', 0, 'airline.passengers', $value + 'Invalid first_name value type in Passenger object', + 0, + 'airline.passengers', + $value ); } } @@ -104,20 +111,28 @@ class Passenger extends AbstractObject implements PassengerInterface { if (empty($value) || is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid last_name value type in Passenger object', 0, 'airline.passengers', $value + 'Invalid last_name value type in Passenger object', + 0, + 'airline.passengers', + $value ); - } else if (TypeCast::canCastToString($value)) { + } elseif (TypeCast::canCastToString($value)) { $length = mb_strlen((string)$value, 'utf-8'); if ($length > 64) { throw new InvalidPropertyValueException( 'Invalid last_name value length in Passenger object', - 0, 'airline.passengers', $value + 0, + 'airline.passengers', + $value ); } $this->_lastName = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid last_name value type in Passenger object', 0, 'airline.passengers', $value + 'Invalid last_name value type in Passenger object', + 0, + 'airline.passengers', + $value ); } } diff --git a/lib/Model/PassengerInterface.php b/lib/Model/PassengerInterface.php index a20588f6..0e14a6dd 100644 --- a/lib/Model/PassengerInterface.php +++ b/lib/Model/PassengerInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - interface PassengerInterface { /** diff --git a/lib/Model/Payment.php b/lib/Model/Payment.php index 15d876e0..a55d46b4 100644 --- a/lib/Model/Payment.php +++ b/lib/Model/Payment.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -254,7 +254,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_status = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment status value type', 0, 'Payment.status', $value + 'Invalid payment status value type', + 0, + 'Payment.status', + $value ); } } @@ -328,7 +331,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'CreatePaymentRequest.description', $value + 'Invalid description value type', + 0, + 'CreatePaymentRequest.description', + $value ); } } @@ -476,7 +482,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_paid = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment paid flag value type', 0, 'Payment.paid', $value + 'Invalid payment paid flag value type', + 0, + 'Payment.paid', + $value ); } } @@ -505,7 +514,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_refundable = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment refundable flag value type', 0, 'Payment.refundable', $value + 'Invalid payment refundable flag value type', + 0, + 'Payment.refundable', + $value ); } } @@ -535,12 +547,18 @@ class Payment extends AbstractObject implements PaymentInterface $this->_receiptRegistration = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid receipt_registration value', 0, 'payment.receiptRegistration', $value + 'Invalid receipt_registration value', + 0, + 'payment.receiptRegistration', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid receipt_registration value type', 0, 'payment.receiptRegistration', $value + 'Invalid receipt_registration value type', + 0, + 'payment.receiptRegistration', + $value ); } } @@ -690,7 +708,8 @@ class Payment extends AbstractObject implements PaymentInterface * @param RequestorInterface|array $value */ public function setRequestor($value) - {} + { + } /** * Возвращает инициатора платежа @@ -723,7 +742,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_test = (bool)$test; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment test flag value type', 0, 'Payment.test', $test + 'Invalid payment test flag value type', + 0, + 'Payment.test', + $test ); } } @@ -753,7 +775,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_deal = new PaymentDealInfo($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal value type in Payment', 0, 'Payment.deal', $value + 'Invalid deal value type in Payment', + 0, + 'Payment.deal', + $value ); } } @@ -790,7 +815,10 @@ class Payment extends AbstractObject implements PaymentInterface $this->_merchant_customer_id = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid merchant_customer_id value type in Payment', 0, 'Payment.merchant_customer_id', $value + 'Invalid merchant_customer_id value type in Payment', + 0, + 'Payment.merchant_customer_id', + $value ); } } diff --git a/lib/Model/PaymentData/AbstractPaymentData.php b/lib/Model/PaymentData/AbstractPaymentData.php index f94edc7c..e326eb76 100644 --- a/lib/Model/PaymentData/AbstractPaymentData.php +++ b/lib/Model/PaymentData/AbstractPaymentData.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -57,23 +57,32 @@ abstract class AbstractPaymentData extends AbstractObject * Устанавливает тип метода оплаты * @param string $value Тип метода оплаты */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty payment data type', 0, 'paymentData.type' + 'Empty payment data type', + 0, + 'paymentData.type' ); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (PaymentMethodType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in PaymentData', 0, 'paymentData.type', $value + 'Invalid value for "type" parameter in PaymentData', + 0, + 'paymentData.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in PaymentData', 0, 'paymentData.type', $value + 'Invalid value type for "type" parameter in PaymentData', + 0, + 'paymentData.type', + $value ); } } diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatData.php b/lib/Model/PaymentData/B2b/Sberbank/VatData.php index 606fcf16..e817f3d0 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatData.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatData.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -95,13 +95,20 @@ class VatData extends AbstractObject implements VatDataInterface { if (TypeCast::canCastToEnumString($value)) { if (!VatDataType::valueExists((string)$value)) { - throw new InvalidPropertyValueException('Invalid B2bSberbankVatData.type value', 0, - 'B2bSberbankVatData.type', $value); + throw new InvalidPropertyValueException( + 'Invalid B2bSberbankVatData.type value', + 0, + 'B2bSberbankVatData.type', + $value + ); } $this->_type = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid B2bSberbankVatData.type value type', 0, 'B2bSberbankVatData.type', $value + 'Invalid B2bSberbankVatData.type value type', + 0, + 'B2bSberbankVatData.type', + $value ); } } @@ -126,13 +133,20 @@ class VatData extends AbstractObject implements VatDataInterface { if (TypeCast::canCastToString($value)) { if (!VatDataRate::valueExists((string)$value)) { - throw new InvalidPropertyValueException('Invalid B2bSberbankVatData.rate value', 0, - 'B2bSberbankVatData.rate', $value); + throw new InvalidPropertyValueException( + 'Invalid B2bSberbankVatData.rate value', + 0, + 'B2bSberbankVatData.rate', + $value + ); } $this->_rate = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid B2bSberbankVatData.rate value type', 0, 'B2bSberbankVatData.rate', $value + 'Invalid B2bSberbankVatData.rate value type', + 0, + 'B2bSberbankVatData.rate', + $value ); } } @@ -161,9 +175,11 @@ class VatData extends AbstractObject implements VatDataInterface $this->_amount->fromArray($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid B2bSberbankVatData.amount value type', 0, 'B2bSberbankVatData.amount', $value + 'Invalid B2bSberbankVatData.amount value type', + 0, + 'B2bSberbankVatData.amount', + $value ); } } - } diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php index 336129eb..66b9940b 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -43,18 +43,17 @@ interface VatDataInterface * Возвращает способ расчёта НДС * @return string Способ расчёта НДС */ - function getType(); + public function getType(); /** * Возвращает данные об НДС * @return string Данные об НДС */ - function getRate(); + public function getRate(); /** * Возвращает сумму НДС * @return AmountInterface Сумма НДС */ - function getAmount(); + public function getAmount(); } - diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php index c2af583c..2bcd3d65 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,12 +30,11 @@ use YooKassa\Common\AbstractEnum; /** * PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС - * |Код|Описание| - * --- | --- - * |7|7%| - * |10|10%| - * |18|18%| - * |20|20%| + * + * - 7 - 7% + * - 10 - 10% + * - 18 - 18% + * - 20 - 20% */ class VatDataRate extends AbstractEnum { @@ -54,5 +53,4 @@ class VatDataRate extends AbstractEnum self::RATE_18 => true, self::RATE_20 => true, ); - } diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php index 08a093b2..cca49393 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,11 +30,11 @@ use YooKassa\Common\AbstractEnum; /** * PaymentDataB2bSberbankVatDataType - Способ расчёта НДС - * |Код|Описание| - * --- | --- - * |calculated|Сумма НДС включена в сумму платежа| - * |mixed|Разные ставки НДС для разных товаров| - * |untaxed|Сумма платежа НДС не облагается| + * + * Возможные значения: + * - calculated - Сумма НДС включена в сумму платежа + * - mixed - Разные ставки НДС для разных товаров + * - untaxed - Сумма платежа НДС не облагается */ class VatDataType extends AbstractEnum { @@ -50,5 +50,4 @@ class VatDataType extends AbstractEnum self::MIXED => true, self::UNTAXED => true, ); - } diff --git a/lib/Model/PaymentData/PaymentDataAlfabank.php b/lib/Model/PaymentData/PaymentDataAlfabank.php index c958a25d..6c2a1f40 100644 --- a/lib/Model/PaymentData/PaymentDataAlfabank.php +++ b/lib/Model/PaymentData/PaymentDataAlfabank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class PaymentDataAlfabank extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::ALFABANK); + $this->setType(PaymentMethodType::ALFABANK); } /** @@ -69,7 +69,10 @@ class PaymentDataAlfabank extends AbstractPaymentData $this->_login = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid login value type', 0, 'PaymentDataAlfabank.login', $value + 'Invalid login value type', + 0, + 'PaymentDataAlfabank.login', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataApplePay.php b/lib/Model/PaymentData/PaymentDataApplePay.php index de797af7..a6738643 100644 --- a/lib/Model/PaymentData/PaymentDataApplePay.php +++ b/lib/Model/PaymentData/PaymentDataApplePay.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,7 +47,7 @@ class PaymentDataApplePay extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::APPLE_PAY); + $this->setType(PaymentMethodType::APPLE_PAY); } /** @@ -67,13 +67,18 @@ class PaymentDataApplePay extends AbstractPaymentData { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for paymentData', 0, 'PaymentDataApplePay.paymentData' + 'Empty value for paymentData', + 0, + 'PaymentDataApplePay.paymentData' ); } elseif (TypeCast::canCastToString($value)) { $this->_paymentData = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for paymentData', 0, 'PaymentDataApplePay.paymentData', $value + 'Invalid value type for paymentData', + 0, + 'PaymentDataApplePay.paymentData', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataB2bSberbank.php b/lib/Model/PaymentData/PaymentDataB2bSberbank.php index ebb3756b..135851a8 100644 --- a/lib/Model/PaymentData/PaymentDataB2bSberbank.php +++ b/lib/Model/PaymentData/PaymentDataB2bSberbank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -53,7 +53,7 @@ class PaymentDataB2bSberbank extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::B2B_SBERBANK); + $this->setType(PaymentMethodType::B2B_SBERBANK); } /** @@ -72,19 +72,28 @@ class PaymentDataB2bSberbank extends AbstractPaymentData public function setPaymentPurpose($value) { if ($value === null || $value === '') { - throw new EmptyPropertyValueException('Empty paymentPurpose value', 0, - 'PaymentDataB2bSberbank.paymentPurpose'); + throw new EmptyPropertyValueException( + 'Empty paymentPurpose value', + 0, + 'PaymentDataB2bSberbank.paymentPurpose' + ); } elseif (TypeCast::canCastToString($value)) { if (preg_match('/^.{1,210}$/', $value)) { $this->_paymentPurpose = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid paymentPurpose value', 0, 'PaymentDataB2bSberbank.paymentPurpose', $value + 'Invalid paymentPurpose value', + 0, + 'PaymentDataB2bSberbank.paymentPurpose', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid paymentPurpose value type', 0, 'PaymentDataB2bSberbank.paymentPurpose', $value + 'Invalid paymentPurpose value type', + 0, + 'PaymentDataB2bSberbank.paymentPurpose', + $value ); } } @@ -116,8 +125,10 @@ class PaymentDataB2bSberbank extends AbstractPaymentData $this->_vatData = $vatData; } else { throw new InvalidPropertyValueTypeException( - 'Invalid vatData value type in PaymentDataB2BSberbank', 0, - 'PaymentDataB2BSberbank.vatData', $value + 'Invalid vatData value type in PaymentDataB2BSberbank', + 0, + 'PaymentDataB2BSberbank.vatData', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataBankCard.php b/lib/Model/PaymentData/PaymentDataBankCard.php index d536930b..e5bc8013 100644 --- a/lib/Model/PaymentData/PaymentDataBankCard.php +++ b/lib/Model/PaymentData/PaymentDataBankCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class PaymentDataBankCard extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::BANK_CARD); + $this->setType(PaymentMethodType::BANK_CARD); } /** @@ -75,7 +75,10 @@ class PaymentDataBankCard extends AbstractPaymentData $this->_card = $card; } else { throw new InvalidPropertyValueTypeException( - 'Invalid card value type in PaymentDataBankCard', 0, 'PaymentDataBankCard.card', $value + 'Invalid card value type in PaymentDataBankCard', + 0, + 'PaymentDataBankCard.card', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataBankCardCard.php b/lib/Model/PaymentData/PaymentDataBankCardCard.php index 22bd27f1..d5a4e5d7 100644 --- a/lib/Model/PaymentData/PaymentDataBankCardCard.php +++ b/lib/Model/PaymentData/PaymentDataBankCardCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -92,12 +92,18 @@ class PaymentDataBankCardCard extends AbstractObject $this->_number = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card number value', 0, 'PaymentDataBankCardCard.number', $value + 'Invalid card number value', + 0, + 'PaymentDataBankCardCard.number', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card number value type', 0, 'PaymentDataBankCardCard.number', $value + 'Invalid card number value type', + 0, + 'PaymentDataBankCardCard.number', + $value ); } } @@ -119,18 +125,26 @@ class PaymentDataBankCardCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card expiry year value', 0, 'PaymentDataBankCardCard.expiryYear' + 'Empty card expiry year value', + 0, + 'PaymentDataBankCardCard.expiryYear' ); } elseif (is_numeric($value)) { if (!preg_match('/^\d\d\d\d$/', $value) || $value < 2000 || $value > 2200) { throw new InvalidPropertyValueException( - 'Invalid card expiry year value', 0, 'PaymentDataBankCardCard.expiryYear', $value + 'Invalid card expiry year value', + 0, + 'PaymentDataBankCardCard.expiryYear', + $value ); } $this->_expiryYear = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card expiry year value', 0, 'PaymentDataBankCardCard.expiryYear', $value + 'Invalid card expiry year value', + 0, + 'PaymentDataBankCardCard.expiryYear', + $value ); } } @@ -152,12 +166,17 @@ class PaymentDataBankCardCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card expiry month value', 0, 'PaymentDataBankCardCard.expiryMonth' + 'Empty card expiry month value', + 0, + 'PaymentDataBankCardCard.expiryMonth' ); } elseif (is_numeric($value)) { if (!preg_match('/^\d\d$/', $value)) { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'PaymentDataBankCardCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'PaymentDataBankCardCard.expiryMonth', + $value ); } if (is_string($value) && $value[0] == '0') { @@ -167,14 +186,20 @@ class PaymentDataBankCardCard extends AbstractObject } if ($month < 1 || $month > 12) { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'PaymentDataBankCardCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'PaymentDataBankCardCard.expiryMonth', + $value ); } else { $this->_expiryMonth = (string)$value; } } else { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'PaymentDataBankCardCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'PaymentDataBankCardCard.expiryMonth', + $value ); } } @@ -196,19 +221,27 @@ class PaymentDataBankCardCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card CSC code value', 0, 'PaymentDataBankCardCard.csc' + 'Empty card CSC code value', + 0, + 'PaymentDataBankCardCard.csc' ); } elseif (is_numeric($value)) { if (preg_match('/^\d{3,4}$/', $value)) { $this->_csc = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card CSC code value', 0, 'PaymentDataBankCardCard.csc', $value + 'Invalid card CSC code value', + 0, + 'PaymentDataBankCardCard.csc', + $value ); } } else { throw new InvalidPropertyValueException( - 'Invalid card CSC code value', 0, 'PaymentDataBankCardCard.csc', $value + 'Invalid card CSC code value', + 0, + 'PaymentDataBankCardCard.csc', + $value ); } } @@ -230,19 +263,27 @@ class PaymentDataBankCardCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card holder value', 0, 'PaymentDataBankCardCard.cardholder' + 'Empty card holder value', + 0, + 'PaymentDataBankCardCard.cardholder' ); } elseif (TypeCast::canCastToString($value)) { if (preg_match('/^[a-zA-Z\s]{1,26}$/', $value)) { $this->_cardholder = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card holder value', 0, 'PaymentDataBankCardCard.cardholder', $value + 'Invalid card holder value', + 0, + 'PaymentDataBankCardCard.cardholder', + $value ); } } else { throw new InvalidPropertyValueException( - 'Invalid card holder value', 0, 'PaymentDataBankCardCard.cardholder', $value + 'Invalid card holder value', + 0, + 'PaymentDataBankCardCard.cardholder', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataCash.php b/lib/Model/PaymentData/PaymentDataCash.php index 1a699e5d..a8b7b088 100644 --- a/lib/Model/PaymentData/PaymentDataCash.php +++ b/lib/Model/PaymentData/PaymentDataCash.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -46,7 +46,7 @@ class PaymentDataCash extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::CASH); + $this->setType(PaymentMethodType::CASH); } /** @@ -71,12 +71,18 @@ class PaymentDataCash extends AbstractPaymentData $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentDataCash.phone', $value + 'Invalid phone value', + 0, + 'PaymentDataCash.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentDataCash.phone', $value + 'Invalid phone value type', + 0, + 'PaymentDataCash.phone', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataFactory.php b/lib/Model/PaymentData/PaymentDataFactory.php index 3801c543..15c46bda 100644 --- a/lib/Model/PaymentData/PaymentDataFactory.php +++ b/lib/Model/PaymentData/PaymentDataFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -65,9 +65,9 @@ class PaymentDataFactory throw new \InvalidArgumentException('Invalid payment type value in payment factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid payment data type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid payment data type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } diff --git a/lib/Model/PaymentData/PaymentDataGooglePay.php b/lib/Model/PaymentData/PaymentDataGooglePay.php index 3578ea09..8733392a 100644 --- a/lib/Model/PaymentData/PaymentDataGooglePay.php +++ b/lib/Model/PaymentData/PaymentDataGooglePay.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -51,7 +51,7 @@ class PaymentDataGooglePay extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::GOOGLE_PAY); + $this->setType(PaymentMethodType::GOOGLE_PAY); } /** @@ -71,13 +71,18 @@ class PaymentDataGooglePay extends AbstractPaymentData { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for paymentMethodToken', 0, 'PaymentDataGooglePay.paymentMethodToken' + 'Empty value for paymentMethodToken', + 0, + 'PaymentDataGooglePay.paymentMethodToken' ); } elseif (TypeCast::canCastToString($value)) { $this->_paymentMethodToken = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for paymentMethodToken', 0, 'PaymentDataGooglePay.paymentMethodToken', $value + 'Invalid value type for paymentMethodToken', + 0, + 'PaymentDataGooglePay.paymentMethodToken', + $value ); } } @@ -99,13 +104,18 @@ class PaymentDataGooglePay extends AbstractPaymentData { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for googleTransactionId', 0, 'PaymentDataGooglePay.googleTransactionId' + 'Empty value for googleTransactionId', + 0, + 'PaymentDataGooglePay.googleTransactionId' ); } elseif (TypeCast::canCastToString($value)) { $this->_googleTransactionId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for googleTransactionId', 0, 'PaymentDataGooglePay.googleTransactionId', $value + 'Invalid value type for googleTransactionId', + 0, + 'PaymentDataGooglePay.googleTransactionId', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataInstallments.php b/lib/Model/PaymentData/PaymentDataInstallments.php index 4b2b5a1a..45aefcb5 100644 --- a/lib/Model/PaymentData/PaymentDataInstallments.php +++ b/lib/Model/PaymentData/PaymentDataInstallments.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -35,6 +35,6 @@ class PaymentDataInstallments extends AbstractPaymentData { public function __construct() { - $this->_setType(PaymentMethodType::INSTALLMENTS); + $this->setType(PaymentMethodType::INSTALLMENTS); } } diff --git a/lib/Model/PaymentData/PaymentDataMobileBalance.php b/lib/Model/PaymentData/PaymentDataMobileBalance.php index 5a89280f..50633338 100644 --- a/lib/Model/PaymentData/PaymentDataMobileBalance.php +++ b/lib/Model/PaymentData/PaymentDataMobileBalance.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,7 +47,7 @@ class PaymentDataMobileBalance extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::MOBILE_BALANCE); + $this->setType(PaymentMethodType::MOBILE_BALANCE); } /** @@ -72,12 +72,18 @@ class PaymentDataMobileBalance extends AbstractPaymentData $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentDataMobileBalance.phone', $value + 'Invalid phone value', + 0, + 'PaymentDataMobileBalance.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentDataMobileBalance.phone', $value + 'Invalid phone value type', + 0, + 'PaymentDataMobileBalance.phone', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataQiwi.php b/lib/Model/PaymentData/PaymentDataQiwi.php index b1d2993e..6d994e97 100644 --- a/lib/Model/PaymentData/PaymentDataQiwi.php +++ b/lib/Model/PaymentData/PaymentDataQiwi.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -46,7 +46,7 @@ class PaymentDataQiwi extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::QIWI); + $this->setType(PaymentMethodType::QIWI); } /** @@ -71,12 +71,18 @@ class PaymentDataQiwi extends AbstractPaymentData $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentDataQiwi.phone', $value + 'Invalid phone value', + 0, + 'PaymentDataQiwi.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentDataQiwi.phone', $value + 'Invalid phone value type', + 0, + 'PaymentDataQiwi.phone', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataSberbank.php b/lib/Model/PaymentData/PaymentDataSberbank.php index f8daf478..b1b7b0d5 100644 --- a/lib/Model/PaymentData/PaymentDataSberbank.php +++ b/lib/Model/PaymentData/PaymentDataSberbank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -51,7 +51,7 @@ class PaymentDataSberbank extends AbstractPaymentData public function __construct() { - $this->_setType(PaymentMethodType::SBERBANK); + $this->setType(PaymentMethodType::SBERBANK); } /** @@ -76,12 +76,18 @@ class PaymentDataSberbank extends AbstractPaymentData $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentDataSberbank.phone', $value + 'Invalid phone value', + 0, + 'PaymentDataSberbank.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentDataSberbank.phone', $value + 'Invalid phone value type', + 0, + 'PaymentDataSberbank.phone', + $value ); } } diff --git a/lib/Model/PaymentData/PaymentDataSbp.php b/lib/Model/PaymentData/PaymentDataSbp.php index 379b2c61..c633a57b 100644 --- a/lib/Model/PaymentData/PaymentDataSbp.php +++ b/lib/Model/PaymentData/PaymentDataSbp.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::SBP); + $this->setType(PaymentMethodType::SBP); } } diff --git a/lib/Model/PaymentData/PaymentDataTinkoffBank.php b/lib/Model/PaymentData/PaymentDataTinkoffBank.php index 20e5cf94..44c447be 100644 --- a/lib/Model/PaymentData/PaymentDataTinkoffBank.php +++ b/lib/Model/PaymentData/PaymentDataTinkoffBank.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::TINKOFF_BANK); + $this->setType(PaymentMethodType::TINKOFF_BANK); } } diff --git a/lib/Model/PaymentData/PaymentDataWebmoney.php b/lib/Model/PaymentData/PaymentDataWebmoney.php index d9a72d36..e679f312 100644 --- a/lib/Model/PaymentData/PaymentDataWebmoney.php +++ b/lib/Model/PaymentData/PaymentDataWebmoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -36,6 +36,6 @@ class PaymentDataWebmoney extends AbstractPaymentData { public function __construct() { - $this->_setType(PaymentMethodType::WEBMONEY); + $this->setType(PaymentMethodType::WEBMONEY); } } diff --git a/lib/Model/PaymentData/PaymentDataWechat.php b/lib/Model/PaymentData/PaymentDataWechat.php index 90a835f8..a5be7210 100644 --- a/lib/Model/PaymentData/PaymentDataWechat.php +++ b/lib/Model/PaymentData/PaymentDataWechat.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::WECHAT); + $this->setType(PaymentMethodType::WECHAT); } } diff --git a/lib/Model/PaymentData/PaymentDataYooMoney.php b/lib/Model/PaymentData/PaymentDataYooMoney.php index 45c32e73..b981a09a 100644 --- a/lib/Model/PaymentData/PaymentDataYooMoney.php +++ b/lib/Model/PaymentData/PaymentDataYooMoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -35,6 +35,6 @@ class PaymentDataYooMoney extends AbstractPaymentData { public function __construct() { - $this->_setType(PaymentMethodType::YOO_MONEY); + $this->setType(PaymentMethodType::YOO_MONEY); } } diff --git a/lib/Model/PaymentInterface.php b/lib/Model/PaymentInterface.php index 3157c4d4..045b6ee9 100644 --- a/lib/Model/PaymentInterface.php +++ b/lib/Model/PaymentInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -70,7 +70,7 @@ interface PaymentInterface * Возвращает идентификатор платежа * @return string Идентификатор платежа */ - function getId(); + public function getId(); /** * Возвращает состояние платежа diff --git a/lib/Model/PaymentMethod/AbstractPaymentMethod.php b/lib/Model/PaymentMethod/AbstractPaymentMethod.php index 16e97d62..1ccd6e0e 100644 --- a/lib/Model/PaymentMethod/AbstractPaymentMethod.php +++ b/lib/Model/PaymentMethod/AbstractPaymentMethod.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -75,23 +75,32 @@ abstract class AbstractPaymentMethod extends AbstractObject * Устанавливает тип объекта * @param string $value Тип объекта */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty payment data type', 0, 'PaymentMethod.type' + 'Empty payment data type', + 0, + 'PaymentMethod.type' ); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (PaymentMethodType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in PaymentMethod', 0, 'PaymentMethod.type', $value + 'Invalid value for "type" parameter in PaymentMethod', + 0, + 'PaymentMethod.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in PaymentMethod', 0, 'PaymentMethod.type', $value + 'Invalid value type for "type" parameter in PaymentMethod', + 0, + 'PaymentMethod.type', + $value ); } } @@ -141,7 +150,10 @@ abstract class AbstractPaymentMethod extends AbstractObject $this->_saved = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid saved value type', 0, 'PaymentMethod.saved', $value + 'Invalid saved value type', + 0, + 'PaymentMethod.saved', + $value ); } } diff --git a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php index 31af7d18..dfb3f50e 100644 --- a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php +++ b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -248,5 +248,4 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa { $this->_account = $value; } - } diff --git a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php index 83d7ca7f..d553224f 100644 --- a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php +++ b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,55 +47,53 @@ interface PayerBankDetailsInterface * Возвращает полное наименование организации * @return string Полное наименование организации */ - function getFullName(); + public function getFullName(); /** * Возвращает сокращенное наименование организации * @return string Сокращенное наименование организации */ - function getShortName(); + public function getShortName(); /** * Возвращает адрес организации * @return string Адрес организации */ - function getAddress(); + public function getAddress(); /** * Возвращает ИНН организации * @return string ИНН организации */ - function getInn(); + public function getInn(); /** * Возвращает КПП организации * @return string КПП организации */ - function getKpp(); + public function getKpp(); /** * Возвращает наименование банка организации * @return string Наименование банка организации */ - function getBankName(); + public function getBankName(); /** * Возвращает отделение банка организации * @return string Отделение банка организации */ - function getBankBranch(); + public function getBankBranch(); /** * Возвращает БИК банка организации * @return string БИК банка организации */ - function getBankBik(); + public function getBankBik(); /** * Возвращает номер счета организации * @return string Номер счета организации */ - function getAccount(); - + public function getAccount(); } - diff --git a/lib/Model/PaymentMethod/BankCard.php b/lib/Model/PaymentMethod/BankCard.php index 50927e80..e1f3f2b6 100644 --- a/lib/Model/PaymentMethod/BankCard.php +++ b/lib/Model/PaymentMethod/BankCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -52,7 +52,7 @@ use YooKassa\Helpers\TypeCast; class BankCard extends AbstractObject { /** - * @var string Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en + * @var int Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en */ const ISO_3166_CODE_LENGTH = 2; @@ -113,17 +113,23 @@ class BankCard extends AbstractObject */ public function setFirst6($value) { - if (TypeCast::canCastToString($value)) { + if (TypeCast::canCastToString($value)) { if (preg_match('/^[0-9]{6}$/', (string)$value)) { $this->_first6 = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card first6 value', 0, 'BankCard.first6', $value + 'Invalid card first6 value', + 0, + 'BankCard.first6', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card first6 value type', 0, 'BankCard.first6', $value + 'Invalid card first6 value type', + 0, + 'BankCard.first6', + $value ); } } @@ -152,12 +158,18 @@ class BankCard extends AbstractObject $this->_last4 = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card last4 value', 0, 'BankCard.last4', $value + 'Invalid card last4 value', + 0, + 'BankCard.last4', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card last4 value type', 0, 'BankCard.last4', $value + 'Invalid card last4 value type', + 0, + 'BankCard.last4', + $value ); } } @@ -179,20 +191,28 @@ class BankCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card expiry year value', 0, 'BankCard.expiryYear' + 'Empty card expiry year value', + 0, + 'BankCard.expiryYear' ); } if (is_numeric($value)) { if (!preg_match('/^\d\d\d\d$/', $value) || $value < 2000 || $value > 2200) { throw new InvalidPropertyValueException( - 'Invalid card expiry year value', 0, 'BankCard.expiryYear', $value + 'Invalid card expiry year value', + 0, + 'BankCard.expiryYear', + $value ); } $this->_expiryYear = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card expiry year value', 0, 'BankCard.expiryYear', $value + 'Invalid card expiry year value', + 0, + 'BankCard.expiryYear', + $value ); } } @@ -214,14 +234,19 @@ class BankCard extends AbstractObject { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty card expiry month value', 0, 'BankCard.expiryMonth' + 'Empty card expiry month value', + 0, + 'BankCard.expiryMonth' ); } if (is_numeric($value)) { if (!preg_match('/^\d\d$/', $value)) { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'BankCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'BankCard.expiryMonth', + $value ); } if (is_string($value) && $value[0] == '0') { @@ -231,14 +256,20 @@ class BankCard extends AbstractObject } if ($month < 1 || $month > 12) { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'BankCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'BankCard.expiryMonth', + $value ); } $this->_expiryMonth = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card expiry month value', 0, 'BankCard.expiryMonth', $value + 'Invalid card expiry month value', + 0, + 'BankCard.expiryMonth', + $value ); } } @@ -266,7 +297,10 @@ class BankCard extends AbstractObject $this->_cardType = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid cardType value type', 0, 'BankCard.cardType', $value + 'Invalid cardType value type', + 0, + 'BankCard.cardType', + $value ); } } @@ -291,11 +325,17 @@ class BankCard extends AbstractObject $this->_issuerCountry = (string)$value; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid issuerCountry value type', 0, 'PaymentMethodBankCard.issuerCountry', $value + 'Invalid issuerCountry value type', + 0, + 'PaymentMethodBankCard.issuerCountry', + $value ); } elseif (mb_strlen($value) !== self::ISO_3166_CODE_LENGTH) { throw new InvalidPropertyValueException( - 'Invalid issuerCountry value', 0, 'PaymentMethodBankCard.issuerCountry', $value + 'Invalid issuerCountry value', + 0, + 'PaymentMethodBankCard.issuerCountry', + $value ); } @@ -312,7 +352,9 @@ class BankCard extends AbstractObject $this->_issuerName = (string)$value; } elseif (!TypeCast::canCastToString($value)) { throw new EmptyPropertyValueException( - 'Empty issuerName value', 0, 'PaymentMethodBankCard.issuerName' + 'Empty issuerName value', + 0, + 'PaymentMethodBankCard.issuerName' ); } @@ -338,11 +380,17 @@ class BankCard extends AbstractObject $this->_source = (string)$value; } elseif (!TypeCast::canCastToEnumString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid source value type', 0, 'PaymentMethodBankCard.source', $value + 'Invalid source value type', + 0, + 'PaymentMethodBankCard.source', + $value ); } elseif (!BankCardSource::valueExists($value)) { throw new InvalidPropertyValueException( - 'Invalid source value', 0, 'PaymentMethodBankCard.source', $value + 'Invalid source value', + 0, + 'PaymentMethodBankCard.source', + $value ); } diff --git a/lib/Model/PaymentMethod/BankCardSource.php b/lib/Model/PaymentMethod/BankCardSource.php index 0573c9c7..807f84db 100644 --- a/lib/Model/PaymentMethod/BankCardSource.php +++ b/lib/Model/PaymentMethod/BankCardSource.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,22 +26,23 @@ namespace YooKassa\Model\PaymentMethod; - use YooKassa\Common\AbstractEnum; /** * BankCardSource - Источник данных банковской карты - * |Код|Описание| - * --- | --- - * |apple_pay|Источник данных apple_pay| - * |google_pay|Источник данных google_pay| - * |mir_pay|Источник данных mir_pay| * + * Возможные значения: + * - apple_pay - Источник данных ApplePay + * - google_pay - Источник данных GooglePay + * - mir_pay - Источник данных MirPay */ class BankCardSource extends AbstractEnum { + /** Источник данных ApplePay */ const APPLE_PAY = 'apple_pay'; + /** Источник данных GooglePay */ const GOOGLE_PAY = 'google_pay'; + /** Источник данных MirPay */ const MIR_PAY = 'mir_pay'; protected static $validValues = array( diff --git a/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php b/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php index c61c47c8..80bf125a 100644 --- a/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php +++ b/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class PaymentMethodAlfaBank extends AbstractPaymentMethod public function __construct() { - $this->_setType(PaymentMethodType::ALFABANK); + $this->setType(PaymentMethodType::ALFABANK); } /** @@ -69,7 +69,10 @@ class PaymentMethodAlfaBank extends AbstractPaymentMethod $this->_login = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid login value type', 0, 'PaymentMethodAlfaBank.login', $value + 'Invalid login value type', + 0, + 'PaymentMethodAlfaBank.login', + $value ); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodApplePay.php b/lib/Model/PaymentMethod/PaymentMethodApplePay.php index fc77e595..f442b89a 100644 --- a/lib/Model/PaymentMethod/PaymentMethodApplePay.php +++ b/lib/Model/PaymentMethod/PaymentMethodApplePay.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodApplePay extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::APPLE_PAY); + $this->setType(PaymentMethodType::APPLE_PAY); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php b/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php index b5b47b85..33708f8b 100644 --- a/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php +++ b/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -59,7 +59,7 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod public function __construct() { - $this->_setType(PaymentMethodType::B2B_SBERBANK); + $this->setType(PaymentMethodType::B2B_SBERBANK); } /** @@ -91,20 +91,19 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod /** * Устанавливает назначение платежа - * @param VatData $vatData Данные об НДС + * @param VatData|array $vatData Данные об НДС */ public function setVatData($vatData) { - if(is_array($vatData)) { + if (is_array($vatData)) { $value = new VatData(); $value->fromArray($vatData); $this->_vatData = $value; - } else if($vatData instanceof VatData){ + } elseif ($vatData instanceof VatData) { $this->_vatData = $vatData; - } else{ + } else { throw new InvalidPropertyValueException('Invalid $vatData property type'); } - } /** @@ -122,13 +121,13 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod */ public function setPayerBankDetails($payerBankDetails) { - if(is_array($payerBankDetails)) { + if (is_array($payerBankDetails)) { $value = new PayerBankDetails(); $value->fromArray($payerBankDetails); $this->_payerBankDetails = $value; - } else if($payerBankDetails instanceof PayerBankDetails){ + } elseif ($payerBankDetails instanceof PayerBankDetails) { $this->_payerBankDetails = $payerBankDetails; - } else{ + } else { throw new InvalidPropertyValueException('Invalid $payerBankDetails property type'); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodBankCard.php b/lib/Model/PaymentMethod/PaymentMethodBankCard.php index 9c567123..cee23674 100644 --- a/lib/Model/PaymentMethod/PaymentMethodBankCard.php +++ b/lib/Model/PaymentMethod/PaymentMethodBankCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -39,7 +39,7 @@ use YooKassa\Model\PaymentMethodType; class PaymentMethodBankCard extends AbstractPaymentMethod { /** - * @var string Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en + * @var int Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en * @deprecated Будет удален в следующих версиях */ const ISO_3166_CODE_LENGTH = 2; @@ -51,7 +51,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod public function __construct() { - $this->_setType(PaymentMethodType::BANK_CARD); + $this->setType(PaymentMethodType::BANK_CARD); } /** @@ -160,7 +160,10 @@ class PaymentMethodBankCard extends AbstractPaymentMethod $this->_card = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid card value type', 0, 'PaymentMethodBankCard.card', $value + 'Invalid card value type', + 0, + 'PaymentMethodBankCard.card', + $value ); } } @@ -177,5 +180,4 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } return $return; } - } diff --git a/lib/Model/PaymentMethod/PaymentMethodCardType.php b/lib/Model/PaymentMethod/PaymentMethodCardType.php index c7e24173..ef72b692 100644 --- a/lib/Model/PaymentMethod/PaymentMethodCardType.php +++ b/lib/Model/PaymentMethod/PaymentMethodCardType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -29,14 +29,23 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Common\AbstractEnum; /** - * Тип банковской карты. Возможные значения: + * PaymentMethodCardType - Тип банковской карты. + * + * Возможные значения: * - `MasterCard` (для карт Mastercard и Maestro), * - `Visa` (для карт Visa и Visa Electron), * - `Mir`, * - `UnionPay`, * - `JCB`, * - `AmericanExpress`, - * - `DinersClub` + * - `DinersClub`, + * - `DiscoverCard`, + * - `InstaPayment`, + * - `InstaPaymentTM`, + * - `Laser`, + * - `Dankort`, + * - `Solo`, + * - `Switch`, * - `Unknown`. */ class PaymentMethodCardType extends AbstractEnum @@ -48,16 +57,30 @@ class PaymentMethodCardType extends AbstractEnum const JCB = 'JCB'; const AMERICAN_EXPRESS = 'AmericanExpress'; const DINERS_CLUB = 'DinersClub'; + const DISCOVER_CARD_CLUB = 'DiscoverCard'; + const INSTA_PAYMENT_CLUB = 'InstaPayment'; + const INSTA_PAYMENT_TM_CLUB = 'InstaPaymentTM'; + const LASER_CLUB = 'Laser'; + const DANKORT_CLUB = 'Dankort'; + const SOLO_CLUB = 'Solo'; + const SWITCH_CLUB = 'Switch'; const UNKNOWN = 'Unknown'; protected static $validValues = array( - self::MASTER_CARD => true, - self::VISA => true, - self::MIR => true, - self::UNION_PAY => true, - self::JCB => true, - self::AMERICAN_EXPRESS => true, - self::DINERS_CLUB => true, - self::UNKNOWN => true, + self::MASTER_CARD => true, + self::VISA => true, + self::MIR => true, + self::UNION_PAY => true, + self::JCB => true, + self::AMERICAN_EXPRESS => true, + self::DINERS_CLUB => true, + self::DISCOVER_CARD_CLUB => true, + self::INSTA_PAYMENT_CLUB => true, + self::INSTA_PAYMENT_TM_CLUB => true, + self::LASER_CLUB => true, + self::DANKORT_CLUB => true, + self::SOLO_CLUB => true, + self::SWITCH_CLUB => true, + self::UNKNOWN => true, ); } diff --git a/lib/Model/PaymentMethod/PaymentMethodCash.php b/lib/Model/PaymentMethod/PaymentMethodCash.php index 9e2a4f2e..bd775fe3 100644 --- a/lib/Model/PaymentMethod/PaymentMethodCash.php +++ b/lib/Model/PaymentMethod/PaymentMethodCash.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodCash extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::CASH); + $this->setType(PaymentMethodType::CASH); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodFactory.php b/lib/Model/PaymentMethod/PaymentMethodFactory.php index 26e6b06c..6482e7c1 100644 --- a/lib/Model/PaymentMethod/PaymentMethodFactory.php +++ b/lib/Model/PaymentMethod/PaymentMethodFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -71,9 +71,9 @@ class PaymentMethodFactory throw new \InvalidArgumentException('Invalid payment method type value in payment factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid payment method data type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid payment method data type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } @@ -110,7 +110,7 @@ class PaymentMethodFactory foreach ($data as $key => $value) { if ($paymentData->offsetExists($key)) { $paymentData->offsetSet($key, $value); - } else if (is_array($value)) { + } elseif (is_array($value)) { $this->fillModel($paymentData, $value); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodGooglePay.php b/lib/Model/PaymentMethod/PaymentMethodGooglePay.php index 8c088058..3cbea0a9 100644 --- a/lib/Model/PaymentMethod/PaymentMethodGooglePay.php +++ b/lib/Model/PaymentMethod/PaymentMethodGooglePay.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodGooglePay extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::GOOGLE_PAY); + $this->setType(PaymentMethodType::GOOGLE_PAY); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodInstallments.php b/lib/Model/PaymentMethod/PaymentMethodInstallments.php index 2f600968..2620ef1c 100644 --- a/lib/Model/PaymentMethod/PaymentMethodInstallments.php +++ b/lib/Model/PaymentMethod/PaymentMethodInstallments.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodInstallments extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::INSTALLMENTS); + $this->setType(PaymentMethodType::INSTALLMENTS); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php b/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php index 25e323c4..c12934ec 100644 --- a/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php +++ b/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -48,7 +48,7 @@ class PaymentMethodMobileBalance extends AbstractPaymentMethod public function __construct() { - $this->_setType(PaymentMethodType::MOBILE_BALANCE); + $this->setType(PaymentMethodType::MOBILE_BALANCE); } /** @@ -73,12 +73,18 @@ class PaymentMethodMobileBalance extends AbstractPaymentMethod $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentMethodMobileBalance.phone', $value + 'Invalid phone value', + 0, + 'PaymentMethodMobileBalance.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentMethodMobileBalance.phone', $value + 'Invalid phone value type', + 0, + 'PaymentMethodMobileBalance.phone', + $value ); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodPsb.php b/lib/Model/PaymentMethod/PaymentMethodPsb.php index 52d70754..7aebac98 100644 --- a/lib/Model/PaymentMethod/PaymentMethodPsb.php +++ b/lib/Model/PaymentMethod/PaymentMethodPsb.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::PSB); + $this->setType(PaymentMethodType::PSB); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodQiwi.php b/lib/Model/PaymentMethod/PaymentMethodQiwi.php index b93ec736..abfc7a0a 100644 --- a/lib/Model/PaymentMethod/PaymentMethodQiwi.php +++ b/lib/Model/PaymentMethod/PaymentMethodQiwi.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodQiwi extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::QIWI); + $this->setType(PaymentMethodType::QIWI); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodSberbank.php b/lib/Model/PaymentMethod/PaymentMethodSberbank.php index 34533089..cccc2222 100644 --- a/lib/Model/PaymentMethod/PaymentMethodSberbank.php +++ b/lib/Model/PaymentMethod/PaymentMethodSberbank.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -52,7 +52,7 @@ class PaymentMethodSberbank extends PaymentMethodBankCard public function __construct() { - $this->_setType(PaymentMethodType::SBERBANK); + $this->setType(PaymentMethodType::SBERBANK); } /** @@ -79,14 +79,19 @@ class PaymentMethodSberbank extends PaymentMethodBankCard $this->_phone = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid phone value', 0, 'PaymentMethodSberbank.phone', $value + 'Invalid phone value', + 0, + 'PaymentMethodSberbank.phone', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid phone value type', 0, 'PaymentMethodSberbank.phone', $value + 'Invalid phone value type', + 0, + 'PaymentMethodSberbank.phone', + $value ); } } - } diff --git a/lib/Model/PaymentMethod/PaymentMethodSbp.php b/lib/Model/PaymentMethod/PaymentMethodSbp.php index e3f31bb6..093f3a92 100644 --- a/lib/Model/PaymentMethod/PaymentMethodSbp.php +++ b/lib/Model/PaymentMethod/PaymentMethodSbp.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::SBP); + $this->setType(PaymentMethodType::SBP); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php b/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php index f33faff0..4683d2a9 100644 --- a/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php +++ b/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::TINKOFF_BANK); + $this->setType(PaymentMethodType::TINKOFF_BANK); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodWebmoney.php b/lib/Model/PaymentMethod/PaymentMethodWebmoney.php index d215f2e1..9eebf902 100644 --- a/lib/Model/PaymentMethod/PaymentMethodWebmoney.php +++ b/lib/Model/PaymentMethod/PaymentMethodWebmoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,6 +37,6 @@ class PaymentMethodWebmoney extends AbstractPaymentMethod { public function __construct() { - $this->_setType(PaymentMethodType::WEBMONEY); + $this->setType(PaymentMethodType::WEBMONEY); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodWechat.php b/lib/Model/PaymentMethod/PaymentMethodWechat.php index 85924c35..061c4a92 100644 --- a/lib/Model/PaymentMethod/PaymentMethodWechat.php +++ b/lib/Model/PaymentMethod/PaymentMethodWechat.php @@ -1,8 +1,9 @@ _setType(PaymentMethodType::WECHAT); + $this->setType(PaymentMethodType::WECHAT); } } diff --git a/lib/Model/PaymentMethod/PaymentMethodYooMoney.php b/lib/Model/PaymentMethod/PaymentMethodYooMoney.php index 8d51e30f..043d78b1 100644 --- a/lib/Model/PaymentMethod/PaymentMethodYooMoney.php +++ b/lib/Model/PaymentMethod/PaymentMethodYooMoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -48,7 +48,7 @@ class PaymentMethodYooMoney extends AbstractPaymentMethod public function __construct() { - $this->_setType(PaymentMethodType::YOO_MONEY); + $this->setType(PaymentMethodType::YOO_MONEY); } /** @@ -68,19 +68,27 @@ class PaymentMethodYooMoney extends AbstractPaymentMethod { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty accountNumber value', 0, 'PaymentMethodYooMoney.accountNumber' + 'Empty accountNumber value', + 0, + 'PaymentMethodYooMoney.accountNumber' ); } elseif (TypeCast::canCastToString($value)) { if (preg_match('/^[0-9]{11,33}$/', $value)) { $this->_accountNumber = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid accountNumber value', 0, 'PaymentMethodYooMoney.accountNumber', $value + 'Invalid accountNumber value', + 0, + 'PaymentMethodYooMoney.accountNumber', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid accountNumber value type', 0, 'PaymentMethodYooMoney.accountNumber', $value + 'Invalid accountNumber value type', + 0, + 'PaymentMethodYooMoney.accountNumber', + $value ); } } diff --git a/lib/Model/PaymentMethodType.php b/lib/Model/PaymentMethodType.php index 8c47663c..de32e81f 100644 --- a/lib/Model/PaymentMethodType.php +++ b/lib/Model/PaymentMethodType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,24 +30,24 @@ use YooKassa\Common\AbstractEnum; /** * PaymentMethodType - Тип источника средств для проведения платежа - * |Код|Описание| - * --- | --- - * |yoo_money|Платеж из кошелька ЮMoney| - * |bank_card|Платеж с произвольной банковской карты| - * |sberbank|Платеж СбербанкОнлайн| - * |cash|Платеж наличными| - * |mobile_balance|Платеж с баланса мобильного телефона| - * |apple_pay|Платеж ApplePay| - * |google_pay|Платеж Google Pay| - * |qiwi|Платеж из кошелька Qiwi| - * |webmoney|Платеж из кошелька Webmoney| - * |alfabank|Платеж через Альфа-Клик| - * |b2b_sberbank|Сбербанк Бизнес Онлайн| - * |tinkoff_bank|Интернет-банк Тинькофф| - * |psb|ПромсвязьБанк| - * |installments|Заплатить по частям| - * |wechat|Платеж через WeChat| - * |sbp|Платеж через через сервис быстрых платежей| + * + * Возможные значения: + * - `yoo_money` - Платеж из кошелька ЮMoney + * - `bank_card` - Платеж с произвольной банковской карты + * - `sberbank` - Платеж СбербанкОнлайн + * - `cash` - Платеж наличными + * - `mobile_balance` - Платеж с баланса мобильного телефона + * - `apple_pay` - Платеж ApplePay + * - `google_pay` - Платеж Google Pay + * - `qiwi` - Платеж из кошелька Qiwi + * - `webmoney` - Платеж из кошелька Webmoney + * - `alfabank` - Платеж через Альфа-Клик + * - `b2b_sberbank` - Сбербанк Бизнес Онлайн + * - `tinkoff_bank` - Интернет-банк Тинькофф + * - `psb` - ПромсвязьБанк + * - `installments` - Заплатить по частям + * - `wechat` - Платеж через WeChat + * - `sbp` - Платеж через через сервис быстрых платежей */ class PaymentMethodType extends AbstractEnum { diff --git a/lib/Model/PaymentStatus.php b/lib/Model/PaymentStatus.php index d6a639e7..e71cde13 100644 --- a/lib/Model/PaymentStatus.php +++ b/lib/Model/PaymentStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,13 +30,12 @@ use YooKassa\Common\AbstractEnum; /** * PaymentStatus - Состояние платежа - * |Код|Описание| - * --- | --- - * |pending|Ожидает оплаты покупателем| - * |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| - * |succeeded|Успешно оплачен и подтвержден магазином| - * |canceled|Неуспех оплаты или отменен магазином (cancel)| * + * Возможные значения: + * - `pending` - Ожидает оплаты покупателем + * - `waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) + * - `succeeded` - Успешно оплачен и подтвержден магазином + * - `canceled` - Неуспех оплаты или отменен магазином (cancel) */ class PaymentStatus extends AbstractEnum { diff --git a/lib/Model/Payout.php b/lib/Model/Payout.php index f1dbb080..0b8a0bca 100644 --- a/lib/Model/Payout.php +++ b/lib/Model/Payout.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -35,8 +35,10 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\Deal\PayoutDealInfo; use YooKassa\Model\PaymentMethod\AbstractPaymentMethod; use YooKassa\Model\Payout\AbstractPayoutDestination; +use YooKassa\Model\Payout\IncomeReceipt; use YooKassa\Model\Payout\PayoutCancellationDetails; use YooKassa\Model\Payout\PayoutDestinationFactory; +use YooKassa\Model\Payout\PayoutSelfEmployed; /** * Payout - Данные о выплате @@ -50,6 +52,9 @@ use YooKassa\Model\Payout\PayoutDestinationFactory; * @property DateTime $createdAt Время создания заказа * @property DateTime $created_at Время создания заказа * @property PayoutDealInfo $deal Сделка, в рамках которой нужно провести выплату + * @property PayoutSelfEmployed $self_employed Данные самозанятого, который получит выплату + * @property PayoutSelfEmployed $selfEmployed Данные самозанятого, который получит выплату + * @property IncomeReceipt $receipt Данные чека, зарегистрированного в ФНС * @property CancellationDetailsInterface $cancellationDetails Комментарий к отмене выплаты * @property CancellationDetailsInterface $cancellation_details Комментарий к отмене выплаты * @property Metadata $metadata Метаданные выплаты указанные мерчантом @@ -95,6 +100,16 @@ class Payout extends AbstractObject implements PayoutInterface */ private $_deal; + /** + * @var PayoutSelfEmployed|null Данные самозанятого, который получит выплату. Присутствует, если вы делаете выплату самозанятому + */ + private $_self_employed; + + /** + * @var IncomeReceipt|null Данные чека, зарегистрированного в ФНС. Присутствует, если вы делаете выплату самозанятому. + */ + private $_receipt; + /** * @var PayoutCancellationDetails Комментарий к статусу canceled: кто отменил выплаты и по какой причине */ @@ -150,19 +165,23 @@ class Payout extends AbstractObject implements PayoutInterface /** * Устанавливает сумму выплаты - * @param AmountInterface|array $value Сумма выплаты + * @param AmountInterface|array|null $value Сумма выплаты */ - public function setAmount($value) + public function setAmount($value = null) { - if ($value === null || $value === '') { + if ($value === null || $value === '' || (is_array($value) && empty($value))) { throw new EmptyPropertyValueException('Empty amount value', 0, 'Payout.amount'); - } elseif ($value instanceof AmountInterface) { + } + if ($value instanceof AmountInterface) { $this->_amount = $value; } elseif (is_array($value)) { $this->_amount = new MonetaryAmount($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid Payout.amount value type', 0, 'Payout.amount', $value + 'Invalid Payout.amount value type', + 0, + 'Payout.amount', + $value ); } } @@ -192,7 +211,10 @@ class Payout extends AbstractObject implements PayoutInterface $this->_status = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid Payout status value type', 0, 'Payout.status', $value + 'Invalid Payout status value type', + 0, + 'Payout.status', + $value ); } } @@ -230,7 +252,10 @@ class Payout extends AbstractObject implements PayoutInterface $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'CreatePayoutRequest.description', $value + 'Invalid description value type', + 0, + 'CreatePayoutRequest.description', + $value ); } } @@ -246,18 +271,18 @@ class Payout extends AbstractObject implements PayoutInterface /** * Устанавливает используемый способ проведения выплаты - * @param AbstractPayoutDestination|array $value Способ проведения выплаты + * @param AbstractPayoutDestination|array|null $value Способ проведения выплаты */ public function setPayoutDestination($value) { - if ($value === null || $value === '') { + if ($value === null || (is_array($value) && empty($value))) { $this->_payout_destination = null; } elseif ($value instanceof AbstractPayoutDestination) { $this->_payout_destination = $value; } elseif (is_array($value)) { $factory = new PayoutDestinationFactory(); $this->_payout_destination = $factory->factoryFromArray($value); - } else { + } else { throw new InvalidPropertyValueTypeException('Invalid payout_destination value type', 0, 'Payout.payout_destination', $value); } @@ -308,7 +333,7 @@ class Payout extends AbstractObject implements PayoutInterface /** * Устанавливает метаданные выплаты - * @param Metadata|array $value Метаданные выплаты указанные мерчантом + * @param Metadata|array|null $value Метаданные выплаты указанные мерчантом */ public function setMetadata($value) { @@ -320,7 +345,10 @@ class Payout extends AbstractObject implements PayoutInterface $this->_metadata = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "metadata" parameter in Payout', 0, 'Payout.metadata', $value + 'Invalid value type for "metadata" parameter in Payout', + 0, + 'Payout.metadata', + $value ); } return $this; @@ -342,7 +370,7 @@ class Payout extends AbstractObject implements PayoutInterface */ public function setCancellationDetails($value) { - if ($value === null) { + if ($value === null || (is_array($value) && empty($value))) { $this->_cancellationDetails = null; } elseif (is_array($value)) { $this->_cancellationDetails = new PayoutCancellationDetails($value); @@ -350,7 +378,10 @@ class Payout extends AbstractObject implements PayoutInterface $this->_cancellationDetails = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "cancellation_details" parameter in Payout', 0, 'Payout.cancellation_details', $value + 'Invalid value type for "cancellation_details" parameter in Payout', + 0, + 'Payout.cancellation_details', + $value ); } } @@ -376,7 +407,10 @@ class Payout extends AbstractObject implements PayoutInterface $this->_test = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid Payout test flag value type', 0, 'Payout.test', $value + 'Invalid Payout test flag value type', + 0, + 'Payout.test', + $value ); } } @@ -392,11 +426,11 @@ class Payout extends AbstractObject implements PayoutInterface /** * Устанавливает сделку, в рамках которой нужно провести выплату - * @param PayoutDealInfo|array $value Сделка, в рамках которой нужно провести выплату + * @param PayoutDealInfo|array|null $value Сделка, в рамках которой нужно провести выплату */ public function setDeal($value) { - if ($value === null || $value === '') { + if ($value === null || (is_array($value) && empty($value))) { $this->_deal = null; } elseif (is_array($value)) { $this->_deal = new PayoutDealInfo($value); @@ -404,9 +438,86 @@ class Payout extends AbstractObject implements PayoutInterface $this->_deal = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "deal" parameter in Payout', 0, 'Payout.deal', $value + 'Invalid value type for "deal" parameter in Payout', + 0, + 'Payout.deal', + $value ); } return $this; } + + /** + * Возвращает данные самозанятого, который получит выплату. + * + * @return PayoutSelfEmployed|null Данные самозанятого, который получит выплату + */ + public function getSelfEmployed() + { + return $this->_self_employed; + } + + /** + * Устанавливает данные самозанятого, который получит выплату. + * + * @param PayoutSelfEmployed|array|null $value Данные самозанятого, который получит выплату + * + * @return $this + */ + public function setSelfEmployed($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_self_employed = null; + } elseif (is_array($value)) { + $this->_self_employed = new PayoutSelfEmployed($value); + } elseif ($value instanceof PayoutSelfEmployed) { + $this->_self_employed = $value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "self_employed" parameter in Payout', + 0, + 'Payout.self_employed', + $value + ); + } + + return $this; + } + + /** + * Возвращает данные чека, зарегистрированного в ФНС. + * + * @return IncomeReceipt|null Данные чека, зарегистрированного в ФНС + */ + public function getReceipt() + { + return $this->_receipt; + } + + /** + * Устанавливает данные чека, зарегистрированного в ФНС. + * + * @param IncomeReceipt|array|null $value Данные чека, зарегистрированного в ФНС + * + * @return $this + */ + public function setReceipt($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_receipt = null; + } elseif (is_array($value)) { + $this->_receipt = new IncomeReceipt($value); + } elseif ($value instanceof IncomeReceipt) { + $this->_receipt = $value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "receipt" parameter in Payout', + 0, + 'Payout.receipt', + $value + ); + } + + return $this; + } } diff --git a/lib/Model/Payout/AbstractPayoutDestination.php b/lib/Model/Payout/AbstractPayoutDestination.php index 07502d9e..4917675d 100644 --- a/lib/Model/Payout/AbstractPayoutDestination.php +++ b/lib/Model/Payout/AbstractPayoutDestination.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -57,23 +57,32 @@ abstract class AbstractPayoutDestination extends AbstractObject * Устанавливает тип метода оплаты * @param string $value Тип метода оплаты */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty PayoutDestinationData data type', 0, 'PayoutDestinationData.type' + 'Empty PayoutDestinationData data type', + 0, + 'PayoutDestinationData.type' ); - } elseif (TypeCast::canCastToEnumString($value)) { + } + if (TypeCast::canCastToEnumString($value)) { if (PaymentMethodType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in PayoutDestinationData', 0, 'PayoutDestinationData.type', $value + 'Invalid value for "type" parameter in PayoutDestinationData', + 0, + 'PayoutDestinationData.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in PayoutDestinationData', 0, 'PayoutDestinationData.type', $value + 'Invalid value type for "type" parameter in PayoutDestinationData', + 0, + 'PayoutDestinationData.type', + $value ); } } diff --git a/lib/Model/Payout/IncomeReceipt.php b/lib/Model/Payout/IncomeReceipt.php new file mode 100644 index 00000000..38ea2843 --- /dev/null +++ b/lib/Model/Payout/IncomeReceipt.php @@ -0,0 +1,238 @@ +/print` + * + * @var string|null + */ + private $_url; + + /** + * Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке. + * + * @var AmountInterface|null + */ + private $_amount; + + + /** + * Возвращает service_name. + * + * @return string + */ + public function getServiceName() + { + return $this->_service_name; + } + + /** + * Устанавливает service_name. + * + * @param string $value Описание услуги, оказанной получателем выплаты. Не более 50 символов. + * + * @return $this + */ + public function setServiceName($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException('Empty service_name value', 0, 'IncomeReceipt.service_name'); + } + if (!TypeCast::canCastToString($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid service_name value type', + 0, + 'IncomeReceipt.service_name', + $value + ); + } + if (mb_strlen($value, 'utf-8') > self::MAX_LENGTH_SERVICE_NAME) { + throw new InvalidPropertyValueException('Invalid IncomeReceipt service_name value', 0, 'IncomeReceipt.service_name', $value); + } + $this->_service_name = (string)$value; + + return $this; + } + + /** + * Возвращает npd_receipt_id. + * + * @return string|null + */ + public function getNpdReceiptId() + { + return $this->_npd_receipt_id; + } + + /** + * Устанавливает npd_receipt_id. + * + * @param string|null $value Идентификатор чека в сервисе. + * + * Пример: ~`208jd98zqe` + * + * @return $this + */ + public function setNpdReceiptId($value = null) + { + if ($value === null || $value === '') { + $this->_npd_receipt_id = null; + } elseif (TypeCast::canCastToString($value)) { + $this->_npd_receipt_id = (string)$value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid npd_receipt_id value type', + 0, + 'IncomeReceipt.npd_receipt_id', + $value + ); + } + + return $this; + } + + /** + * Возвращает Ссылка на зарегистрированный чек. + * + * @return string|null + */ + public function getUrl() + { + return $this->_url; + } + + /** + * Устанавливает ссылка на зарегистрированный чек. + * + * @param string|null $value Ссылка на зарегистрированный чек + * + * Пример: ~`https://www.nalog.gov.ru/api/v1/receipt/<Идентификатор чека>/print` + * + * @return $this + */ + public function setUrl($value = null) + { + if ($value === null || $value === '') { + $this->_url = null; + } elseif (TypeCast::canCastToString($value)) { + $this->_url = (string)$value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid url value type', + 0, + 'IncomeReceipt.url', + $value + ); + } + + return $this; + } + + /** + * Возвращает amount. + * + * @return AmountInterface|null + */ + public function getAmount() + { + return $this->_amount; + } + + /** + * Устанавливает amount. + * + * @param AmountInterface|array|null $value + * + * @return $this + */ + public function setAmount($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_amount = null; + } elseif ($value instanceof AmountInterface) { + $this->_amount = $value; + } elseif (is_array($value)) { + $this->_amount = new MonetaryAmount($value); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid IncomeReceipt.amount value type', + 0, + 'IncomeReceipt.amount', + $value + ); + } + + return $this; + } +} diff --git a/lib/Model/Payout/PayoutCancellationDetails.php b/lib/Model/Payout/PayoutCancellationDetails.php index 68ebf281..76a46d2a 100644 --- a/lib/Model/Payout/PayoutCancellationDetails.php +++ b/lib/Model/Payout/PayoutCancellationDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Payout/PayoutCancellationDetailsPartyCode.php b/lib/Model/Payout/PayoutCancellationDetailsPartyCode.php index 7656bbef..86334d1a 100644 --- a/lib/Model/Payout/PayoutCancellationDetailsPartyCode.php +++ b/lib/Model/Payout/PayoutCancellationDetailsPartyCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -35,20 +35,14 @@ class PayoutCancellationDetailsPartyCode extends AbstractEnum { /** * Платформа (вы) + * @deprecated Будет удален в будущих версиях */ const MERCHANT = 'merchant'; - - /** - * ЮKassa - */ + /** ЮKassa */ const YOO_KASSA = 'yoo_kassa'; - - /** - * «Внешние» участники процесса выплаты (например, эмитент, сторонний платежный сервис) - */ + /** «Внешние» участники процесса выплаты (например, эмитент, сторонний платежный сервис) */ const PAYMENT_NETWORK = 'payment_network'; - protected static $validValues = array( self::MERCHANT => true, self::YOO_KASSA => true, diff --git a/lib/Model/Payout/PayoutCancellationDetailsReasonCode.php b/lib/Model/Payout/PayoutCancellationDetailsReasonCode.php index 77afdac8..f8d5e868 100644 --- a/lib/Model/Payout/PayoutCancellationDetailsReasonCode.php +++ b/lib/Model/Payout/PayoutCancellationDetailsReasonCode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Payout/PayoutDestinationBankCard.php b/lib/Model/Payout/PayoutDestinationBankCard.php index 29da9e93..963af1d1 100644 --- a/lib/Model/Payout/PayoutDestinationBankCard.php +++ b/lib/Model/Payout/PayoutDestinationBankCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class PayoutDestinationBankCard extends AbstractPayoutDestination public function __construct() { - $this->_setType(PaymentMethodType::BANK_CARD); + $this->setType(PaymentMethodType::BANK_CARD); } /** @@ -75,7 +75,10 @@ class PayoutDestinationBankCard extends AbstractPayoutDestination $this->_card = $card; } else { throw new InvalidPropertyValueTypeException( - 'Invalid card value type in PayoutDestinationBankCard', 0, 'PayoutDestinationBankCard.card', $value + 'Invalid card value type in PayoutDestinationBankCard', + 0, + 'PayoutDestinationBankCard.card', + $value ); } } diff --git a/lib/Model/Payout/PayoutDestinationBankCardCard.php b/lib/Model/Payout/PayoutDestinationBankCardCard.php index 3c34ae6c..86723e77 100644 --- a/lib/Model/Payout/PayoutDestinationBankCardCard.php +++ b/lib/Model/Payout/PayoutDestinationBankCardCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,7 +47,7 @@ use YooKassa\Helpers\TypeCast; class PayoutDestinationBankCardCard extends AbstractObject { /** - * @var string Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en + * @var int Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en */ const ISO_3166_CODE_LENGTH = 2; @@ -98,12 +98,18 @@ class PayoutDestinationBankCardCard extends AbstractObject $this->_last4 = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card last4 value', 0, 'PaymentMethodBankCard.last4', $value + 'Invalid card last4 value', + 0, + 'PaymentMethodBankCard.last4', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card last4 value type', 0, 'PaymentMethodBankCard.last4', $value + 'Invalid card last4 value type', + 0, + 'PaymentMethodBankCard.last4', + $value ); } } @@ -132,12 +138,18 @@ class PayoutDestinationBankCardCard extends AbstractObject $this->_first6 = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card first6 value', 0, 'PaymentMethodBankCard.first6', $value + 'Invalid card first6 value', + 0, + 'PaymentMethodBankCard.first6', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card first6 value type', 0, 'PaymentMethodBankCard.first6', $value + 'Invalid card first6 value type', + 0, + 'PaymentMethodBankCard.first6', + $value ); } } @@ -163,7 +175,10 @@ class PayoutDestinationBankCardCard extends AbstractObject $this->_cardType = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid cardType value type', 0, 'PaymentMethodBankCard.cardType', $value + 'Invalid cardType value type', + 0, + 'PaymentMethodBankCard.cardType', + $value ); } } @@ -187,11 +202,17 @@ class PayoutDestinationBankCardCard extends AbstractObject $this->_issuerCountry = (string)$value; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid issuerCountry value type', 0, 'PaymentMethodBankCard.issuerCountry', $value + 'Invalid issuerCountry value type', + 0, + 'PaymentMethodBankCard.issuerCountry', + $value ); } elseif (mb_strlen($value) !== self::ISO_3166_CODE_LENGTH) { throw new InvalidPropertyValueException( - 'Invalid issuerCountry value', 0, 'PaymentMethodBankCard.issuerCountry', $value + 'Invalid issuerCountry value', + 0, + 'PaymentMethodBankCard.issuerCountry', + $value ); } @@ -208,7 +229,9 @@ class PayoutDestinationBankCardCard extends AbstractObject $this->_issuerName = (string)$value; } elseif (!TypeCast::canCastToString($value)) { throw new EmptyPropertyValueException( - 'Empty issuerName value', 0, 'PaymentMethodBankCard.issuerName' + 'Empty issuerName value', + 0, + 'PaymentMethodBankCard.issuerName' ); } @@ -223,5 +246,4 @@ class PayoutDestinationBankCardCard extends AbstractObject { return $this->_issuerName; } - } diff --git a/lib/Model/Payout/PayoutDestinationFactory.php b/lib/Model/Payout/PayoutDestinationFactory.php index 567bff52..f271de50 100644 --- a/lib/Model/Payout/PayoutDestinationFactory.php +++ b/lib/Model/Payout/PayoutDestinationFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -38,6 +38,7 @@ class PayoutDestinationFactory private $typeClassMap = array( PaymentMethodType::YOO_MONEY => 'PayoutDestinationYooMoney', PaymentMethodType::BANK_CARD => 'PayoutDestinationBankCard', + PaymentMethodType::SBP => 'PayoutDestinationSbp', ); /** @@ -52,9 +53,9 @@ class PayoutDestinationFactory throw new \InvalidArgumentException('Invalid payment type value in payment factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid payment data type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid payment data type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } diff --git a/lib/Model/Payout/PayoutDestinationSbp.php b/lib/Model/Payout/PayoutDestinationSbp.php new file mode 100644 index 00000000..c29c8ed1 --- /dev/null +++ b/lib/Model/Payout/PayoutDestinationSbp.php @@ -0,0 +1,177 @@ +setType(PaymentMethodType::SBP); + } + + /** + * Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + * + * @return string Телефон, к которому привязан счет получателя выплаты в системе участника СБП + */ + public function getPhone() + { + return $this->_phone; + } + + /** + * Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + * + * @param string $phone Телефон, к которому привязан счет получателя выплаты в системе участника СБП + * + * @return $this + */ + public function setPhone($phone) + { + if ($phone === null || $phone === '') { + throw new EmptyPropertyValueException('Empty phone value', 0, 'PayoutDestinationSbp.phone'); + } + if (!TypeCast::canCastToString($phone)) { + throw new InvalidPropertyValueTypeException('Invalid phone value type', 0, 'PayoutDestinationSbp.phone'); + } + $this->_phone = (string)preg_replace('/\D/', '', $phone); + + return $this; + } + + /** + * Возвращает идентификатор выбранного участника СБП. + * + * @return string Идентификатор выбранного участника СБП + */ + public function getBankId() + { + return $this->_bank_id; + } + + /** + * Устанавливает идентификатор выбранного участника СБП. + * + * @param string $bankId Идентификатор выбранного участника СБП + * + * @return $this + */ + public function setBankId($bankId) + { + if ($bankId === null || $bankId === '') { + throw new EmptyPropertyValueException('Empty bank_id value', 0, 'PayoutDestinationSbp.bank_id'); + } + if (!TypeCast::canCastToString($bankId)) { + throw new InvalidPropertyValueTypeException('Invalid bank_id value type', 0, 'PayoutDestinationSbp.bank_id', $bankId); + } + if (mb_strlen($bankId) > 12) { + throw new InvalidPropertyValueException('Invalid bank_id value', 0, 'PayoutDestinationSbp.bank_id', $bankId); + } + $this->_bank_id = (string)$bankId; + + return $this; + } + + /** + * Возвращает признак тестовой операции + * @return bool Признак тестовой операции + */ + public function getRecipientChecked() + { + return $this->_recipient_checked; + } + + /** + * Устанавливает признак тестовой операции + * @param bool $value Признак тестовой операции + */ + public function setRecipientChecked($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException( + 'Empty PayoutDestinationSbp recipient_checked flag value', + 0, + 'PayoutDestinationSbp.recipient_checked' + ); + } + if (!TypeCast::canCastToBoolean($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid PayoutDestinationSbp recipient_checked flag value type', + 0, + 'PayoutDestinationSbp.recipient_checked', + $value + ); + } + + $this->_recipient_checked = (bool)$value; + + return $this; + } +} diff --git a/lib/Model/Payout/PayoutDestinationType.php b/lib/Model/Payout/PayoutDestinationType.php index 3c03cb22..c09078dd 100644 --- a/lib/Model/Payout/PayoutDestinationType.php +++ b/lib/Model/Payout/PayoutDestinationType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -31,15 +31,17 @@ use YooKassa\Model\PaymentMethodType; /** * PayoutDestinationType - Виды выплат - * |Код|Описание| - * --- | --- - * |yoo_money|Выплата в кошелек ЮMoney| - * |bank_card|Выплата на произвольную банковскую карту| + * + * Возможные значения: + * - `yoo_money` - Выплата в кошелек ЮMoney + * - `bank_card` - Выплата на произвольную банковскую карту + * - `sbp` - Выплата через СБП на счет в банке или платежном сервисе */ class PayoutDestinationType extends AbstractEnum { protected static $validValues = array( PaymentMethodType::YOO_MONEY => true, PaymentMethodType::BANK_CARD => true, + PaymentMethodType::SBP => true, ); } diff --git a/lib/Model/Payout/PayoutDestinationYooMoney.php b/lib/Model/Payout/PayoutDestinationYooMoney.php index 34a2fc98..976f1514 100644 --- a/lib/Model/Payout/PayoutDestinationYooMoney.php +++ b/lib/Model/Payout/PayoutDestinationYooMoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -48,7 +48,7 @@ class PayoutDestinationYooMoney extends AbstractPayoutDestination public function __construct() { - $this->_setType(PaymentMethodType::YOO_MONEY); + $this->setType(PaymentMethodType::YOO_MONEY); } /** @@ -68,19 +68,27 @@ class PayoutDestinationYooMoney extends AbstractPayoutDestination { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty accountNumber value', 0, 'PayoutDestinationYooMoney.accountNumber' + 'Empty accountNumber value', + 0, + 'PayoutDestinationYooMoney.accountNumber' ); } elseif (TypeCast::canCastToString($value)) { if (preg_match('/^[0-9]{11,33}$/', $value)) { $this->_accountNumber = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid accountNumber value', 0, 'PayoutDestinationYooMoney.accountNumber', $value + 'Invalid accountNumber value', + 0, + 'PayoutDestinationYooMoney.accountNumber', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid accountNumber value type', 0, 'PayoutDestinationYooMoney.accountNumber', $value + 'Invalid accountNumber value type', + 0, + 'PayoutDestinationYooMoney.accountNumber', + $value ); } } diff --git a/lib/Model/Payout/PayoutSelfEmployed.php b/lib/Model/Payout/PayoutSelfEmployed.php new file mode 100644 index 00000000..64c08c73 --- /dev/null +++ b/lib/Model/Payout/PayoutSelfEmployed.php @@ -0,0 +1,80 @@ +_id; + } + + /** + * Устанавливает идентификатор самозанятого в ЮKassa. + * + * @param string $id Идентификатор самозанятого в ЮKassa. + * + * @return $this + */ + public function setId($id) + { + if (!TypeCast::canCastToString($id)) { + throw new InvalidPropertyValueTypeException('Invalid PayoutSelfEmployed id value type', 0, 'PayoutSelfEmployed.id', $id); + } + $length = mb_strlen($id, 'utf-8'); + if ($length < SelfEmployedInterface::MIN_LENGTH_ID || $length > SelfEmployedInterface::MAX_LENGTH_ID) { + throw new InvalidPropertyValueException('Invalid PayoutSelfEmployed id value', 0, 'PayoutSelfEmployed.id', $id); + } + $this->_id = (string)$id; + + return $this; + } +} diff --git a/lib/Model/Payout/SbpParticipantBank.php b/lib/Model/Payout/SbpParticipantBank.php new file mode 100644 index 00000000..653e0928 --- /dev/null +++ b/lib/Model/Payout/SbpParticipantBank.php @@ -0,0 +1,135 @@ +_bank_id; + } + + /** + * Устанавливает bank_id. + * + * @param string $bank_id Идентификатор банка или платежного сервиса в СБП. + * + * @return $this + */ + public function setBankId($bank_id) + { + $this->_bank_id = $bank_id; + + return $this; + } + + /** + * Возвращает name. + * + * @return string + */ + public function getName() + { + return $this->_name; + } + + /** + * Устанавливает name. + * + * @param string $name Название банка или платежного сервиса в СБП. + * + * @return $this + */ + public function setName($name) + { + $this->_name = $name; + + return $this; + } + + /** + * Возвращает bic. + * + * @return string + */ + public function getBic() + { + return $this->_bic; + } + + /** + * Устанавливает bic. + * + * @param string $bic Банковский идентификационный код (БИК) банка или платежного сервиса. + * + * @return $this + */ + public function setBic($bic) + { + $this->_bic = $bic; + + return $this; + } +} diff --git a/lib/Model/PayoutInterface.php b/lib/Model/PayoutInterface.php index 5fb2ecf7..e1d7b22f 100644 --- a/lib/Model/PayoutInterface.php +++ b/lib/Model/PayoutInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/PayoutStatus.php b/lib/Model/PayoutStatus.php index 69847190..1208f503 100644 --- a/lib/Model/PayoutStatus.php +++ b/lib/Model/PayoutStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,12 +30,11 @@ use YooKassa\Common\AbstractEnum; /** * PayoutStatus - Статус выплаты - * |Код|Описание| - * --- | --- - * |pending|Выплата создана и ожидает подтверждения от эмитента| - * |succeeded|Выплата успешно завершена| - * |canceled|Выплата отменена| * + * Возможные значения: + * - `pending` - Выплата создана и ожидает подтверждения от эмитента + * - `succeeded` - Выплата успешно завершена + * - `canceled` - Выплата отменена */ class PayoutStatus extends AbstractEnum { diff --git a/lib/Model/PersonalData/PersonalData.php b/lib/Model/PersonalData/PersonalData.php new file mode 100644 index 00000000..1a70ee34 --- /dev/null +++ b/lib/Model/PersonalData/PersonalData.php @@ -0,0 +1,360 @@ +_id; + } + + /** + * Устанавливает id. + * + * @param string $id Идентификатор персональных данных, сохраненных в ЮKassa. + * + * @return $this + */ + public function setId($id) + { + if (!TypeCast::canCastToString($id)) { + throw new InvalidPropertyValueTypeException('Invalid PersonalData id value type', 0, 'PersonalData.id', $id); + } + $length = mb_strlen($id, 'utf-8'); + if ($length < PersonalDataInterface::MIN_LENGTH_ID || $length > PersonalDataInterface::MAX_LENGTH_ID) { + throw new InvalidPropertyValueException('Invalid PersonalData id value', 0, 'PersonalData.id', $id); + } + $this->_id = (string)$id; + + return $this; + } + + /** + * Возвращает тип персональных данных. + * + * @return string Тип персональных данных + */ + public function getType() + { + return $this->_type; + } + + /** + * Устанавливает тип персональных данных. + * + * @param string $type Тип персональных данных + * + * @return $this + */ + public function setType($type) + { + if (!TypeCast::canCastToEnumString($type)) { + throw new InvalidPropertyValueTypeException('Invalid PersonalData type value type', 0, 'PersonalData.type', $type); + } + if (!PersonalDataType::valueExists((string)$type)) { + throw new InvalidPropertyValueException('Invalid PersonalData type value', 0, 'PersonalData.type', $type); + } + $this->_type = (string)$type; + + return $this; + } + + /** + * Возвращает статус персональных данных. + * + * @return string Статус персональных данных + */ + public function getStatus() + { + return $this->_status; + } + + /** + * Устанавливает статус персональных данных. + * + * @param string $status Статус персональных данных + * + * @return $this + */ + public function setStatus($status) + { + if (!TypeCast::canCastToEnumString($status)) { + throw new InvalidPropertyValueTypeException('Invalid PersonalData status value type', 0, 'PersonalData.status', $status); + } + if (!PersonalDataStatus::valueExists((string)$status)) { + throw new InvalidPropertyValueException('Invalid PersonalData status value', 0, 'PersonalData.status', $status); + } + $this->_status = (string)$status; + + return $this; + } + + /** + * Возвращает cancellation_details. + * + * @return PersonalDataCancellationDetails|null + */ + public function getCancellationDetails() + { + return $this->_cancellation_details; + } + + /** + * Устанавливает cancellation_details. + * + * @param PersonalDataCancellationDetails|array|null $cancellation_details + * + * @return $this + */ + public function setCancellationDetails($cancellation_details) + { + if ($cancellation_details === null) { + $this->_cancellation_details = null; + } elseif (is_array($cancellation_details)) { + $this->_cancellation_details = new PersonalDataCancellationDetails($cancellation_details); + } elseif ($cancellation_details instanceof PersonalDataCancellationDetails) { + $this->_cancellation_details = $cancellation_details; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "cancellation_details" parameter in PersonalData', + 0, + 'PersonalData.cancellation_details', + $cancellation_details + ); + } + + return $this; + } + + /** + * Возвращает created_at. + * + * @return DateTime + */ + public function getCreatedAt() + { + return $this->_created_at; + } + + /** + * Устанавливает время создания персональных данных. + * + * @param DateTime|string|int $created_at Время создания персональных данных + * + * @return $this + * @throws Exception + */ + public function setCreatedAt($created_at) + { + if ($created_at === null || $created_at === '') { + throw new EmptyPropertyValueException('Empty created_at value', 0, 'PersonalData.createdAt'); + } + if (!TypeCast::canCastToDateTime($created_at)) { + throw new InvalidPropertyValueTypeException('Invalid created_at value', 0, 'PersonalData.createdAt', $created_at); + } + $dateTime = TypeCast::castToDateTime($created_at); + if ($dateTime === null) { + throw new InvalidPropertyValueException('Invalid created_at value', 0, 'PersonalData.createdAt', $created_at); + } + $this->_created_at = $dateTime; + + return $this; + } + + /** + * Возвращает срок жизни объекта персональных данных. + * + * @return DateTime|null Срок жизни объекта персональных данных + */ + public function getExpiresAt() + { + return $this->_expires_at; + } + + /** + * Устанавливает срок жизни объекта персональных данных. + * + * @param DateTime|string|int|null $expires_at Срок жизни объекта персональных данных + * + * @return $this + * @throws Exception + */ + public function setExpiresAt($expires_at = null) + { + if ($expires_at === null || $expires_at === '') { + $this->_expires_at = null; + } elseif (TypeCast::canCastToDateTime($expires_at)) { + $dateTime = TypeCast::castToDateTime($expires_at); + if ($dateTime === null) { + throw new InvalidPropertyValueException('Invalid expires_at value', 0, 'PersonalData.expiresAt', $expires_at); + } + $this->_expires_at = $dateTime; + } else { + throw new InvalidPropertyValueTypeException('Invalid expires_at value', 0, 'PersonalData.expiresAt', $expires_at); + } + + return $this; + } + + /** + * Возвращает любые дополнительные данные. + * + * @return array|null Любые дополнительные данные + */ + public function getMetadata() + { + return $this->_metadata; + } + + /** + * Устанавливает любые дополнительные данные. + * + * @param Metadata|array|null $metadata Любые дополнительные данные + * + * @return $this + */ + public function setMetadata($metadata = null) + { + if ($metadata === null || $metadata === '') { + $this->_metadata = null; + } elseif (is_array($metadata)) { + $this->_metadata = new Metadata($metadata); + } elseif ($metadata instanceof Metadata) { + $this->_metadata = $metadata; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid metadata type for "metadata" parameter in PersonalData', + 0, + 'PersonalData.metadata', + $metadata + ); + } + + return $this; + } +} diff --git a/lib/Model/PersonalData/PersonalDataCancellationDetails.php b/lib/Model/PersonalData/PersonalDataCancellationDetails.php new file mode 100644 index 00000000..c2c988a8 --- /dev/null +++ b/lib/Model/PersonalData/PersonalDataCancellationDetails.php @@ -0,0 +1,125 @@ +_party; + } + + /** + * Устанавливает участника процесса, который принял решение о прекращении хранения персональных данных. + * + * @param string $value Участник процесса, который принял решение о прекращении хранения персональных данных + * + * @return self + */ + public function setParty($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException('Empty party value', 0, 'PersonalDataCancellationDetails.party'); + } + if (!TypeCast::canCastToString($value)) { + throw new InvalidPropertyValueTypeException('Invalid party value type', 0, 'PersonalDataCancellationDetails.party', $value); + } + $this->_party = strtolower((string)$value); + + return $this; + } + + /** + * Возвращает reason. + * + * @return string + */ + public function getReason() + { + return $this->_reason; + } + + /** + * Устанавливает причину прекращения хранения персональных данных. + * + * @param string $value Причина прекращения хранения персональных данных + * + * @return self + */ + public function setReason($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException('Empty reason value', 0, 'PersonalDataCancellationDetails.reason'); + } + if (!TypeCast::canCastToString($value)) { + throw new InvalidPropertyValueTypeException('Invalid reason value type', 0, 'PersonalDataCancellationDetails.reason'); + } + $this->_reason = strtolower((string)$value); + + return $this; + } +} diff --git a/lib/Model/PersonalData/PersonalDataCancellationDetailsPartyCode.php b/lib/Model/PersonalData/PersonalDataCancellationDetailsPartyCode.php new file mode 100644 index 00000000..564cac5e --- /dev/null +++ b/lib/Model/PersonalData/PersonalDataCancellationDetailsPartyCode.php @@ -0,0 +1,42 @@ + true, + ); +} diff --git a/lib/Model/PersonalData/PersonalDataCancellationDetailsReasonCode.php b/lib/Model/PersonalData/PersonalDataCancellationDetailsReasonCode.php new file mode 100644 index 00000000..cf9e5708 --- /dev/null +++ b/lib/Model/PersonalData/PersonalDataCancellationDetailsReasonCode.php @@ -0,0 +1,42 @@ + true, + ); +} diff --git a/lib/Model/PersonalData/PersonalDataInterface.php b/lib/Model/PersonalData/PersonalDataInterface.php new file mode 100644 index 00000000..36873027 --- /dev/null +++ b/lib/Model/PersonalData/PersonalDataInterface.php @@ -0,0 +1,158 @@ + true, + self::ACTIVE => true, + self::CANCELED => true, + ); +} diff --git a/lib/Model/PersonalData/PersonalDataType.php b/lib/Model/PersonalData/PersonalDataType.php new file mode 100644 index 00000000..e1a3f3cd --- /dev/null +++ b/lib/Model/PersonalData/PersonalDataType.php @@ -0,0 +1,53 @@ + true, + ); +} diff --git a/lib/Model/Receipt.php b/lib/Model/Receipt.php index f09be79a..e76d7f4f 100644 --- a/lib/Model/Receipt.php +++ b/lib/Model/Receipt.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -141,7 +141,10 @@ class Receipt extends AbstractObject implements ReceiptInterface } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid items value type in receipt', 0, 'receipt.items', $value + 'Invalid items value type in receipt', + 0, + 'receipt.items', + $value ); } $this->_items = array(); @@ -151,7 +154,10 @@ class Receipt extends AbstractObject implements ReceiptInterface $this->addItem($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid item value type in receipt', 0, 'receipt.items['.$key.']', $val + 'Invalid item value type in receipt', + 0, + 'receipt.items[' . $key . ']', + $val ); } } @@ -192,7 +198,10 @@ class Receipt extends AbstractObject implements ReceiptInterface } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in receipt', 0, 'receipt.settlements', $value + 'Invalid settlements value type in receipt', + 0, + 'receipt.settlements', + $value ); } $this->_settlements = array(); @@ -203,7 +212,10 @@ class Receipt extends AbstractObject implements ReceiptInterface $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in receipt', 0, 'receipt.settlements['.$key.']', $val + 'Invalid settlements value type in receipt', + 0, + 'receipt.settlements[' . $key . ']', + $val ); } } @@ -279,7 +291,10 @@ class Receipt extends AbstractObject implements ReceiptInterface $this->_additionalUserProps = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid additionalUserProps value type in receipt', 0, 'Receipt.additional_user_props', $value + 'Invalid additionalUserProps value type in receipt', + 0, + 'Receipt.additional_user_props', + $value ); } } @@ -601,5 +616,4 @@ class Receipt extends AbstractObject implements ReceiptInterface { return null; } - } diff --git a/lib/Model/Receipt/AdditionalUserProps.php b/lib/Model/Receipt/AdditionalUserProps.php index 5ec5482a..0bbef5e5 100644 --- a/lib/Model/Receipt/AdditionalUserProps.php +++ b/lib/Model/Receipt/AdditionalUserProps.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Receipt/AgentType.php b/lib/Model/Receipt/AgentType.php index 580c9d98..496a2d32 100644 --- a/lib/Model/Receipt/AgentType.php +++ b/lib/Model/Receipt/AgentType.php @@ -1,19 +1,64 @@ true, self::AGENT => true, ); -} \ No newline at end of file +} diff --git a/lib/Model/Receipt/IndustryDetails.php b/lib/Model/Receipt/IndustryDetails.php index efa42393..441ef6e3 100644 --- a/lib/Model/Receipt/IndustryDetails.php +++ b/lib/Model/Receipt/IndustryDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Receipt/MarkCodeInfo.php b/lib/Model/Receipt/MarkCodeInfo.php index 25c2e7ea..8faf1fdc 100644 --- a/lib/Model/Receipt/MarkCodeInfo.php +++ b/lib/Model/Receipt/MarkCodeInfo.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Receipt/MarkQuantity.php b/lib/Model/Receipt/MarkQuantity.php index cbb949cf..30efa576 100644 --- a/lib/Model/Receipt/MarkQuantity.php +++ b/lib/Model/Receipt/MarkQuantity.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Receipt/OperationalDetails.php b/lib/Model/Receipt/OperationalDetails.php index 9309cd22..20356326 100644 --- a/lib/Model/Receipt/OperationalDetails.php +++ b/lib/Model/Receipt/OperationalDetails.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Receipt/PaymentMode.php b/lib/Model/Receipt/PaymentMode.php index 9f42c3a2..36f2d3ea 100644 --- a/lib/Model/Receipt/PaymentMode.php +++ b/lib/Model/Receipt/PaymentMode.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -33,19 +33,19 @@ use YooKassa\Common\AbstractEnum; */ class PaymentMode extends AbstractEnum { - /** @var string Полная предоплата */ + /** Полная предоплата */ const FULL_PREPAYMENT = 'full_prepayment'; - /** @var string Частичная предоплата */ + /** Частичная предоплата */ const PARTIAL_PREPAYMENT = 'partial_prepayment'; - /** @var string Аванс */ + /** Аванс */ const ADVANCE = 'advance'; - /** @var string Полный расчет */ + /** Полный расчет */ const FULL_PAYMENT = 'full_payment'; - /** @var string Частичный расчет и кредит */ + /** Частичный расчет и кредит */ const PARTIAL_PAYMENT = 'partial_payment'; - /** @var string Кредит */ + /** Кредит */ const CREDIT = 'credit'; - /** @var string Выплата по кредиту */ + /** Выплата по кредиту */ const CREDIT_PAYMENT = 'credit_payment'; protected static $validValues = array( diff --git a/lib/Model/Receipt/PaymentSubject.php b/lib/Model/Receipt/PaymentSubject.php index e8069c1e..9add6348 100644 --- a/lib/Model/Receipt/PaymentSubject.php +++ b/lib/Model/Receipt/PaymentSubject.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -33,72 +33,72 @@ use YooKassa\Common\AbstractEnum; */ class PaymentSubject extends AbstractEnum { - /** @var string Товар */ + /** Товар */ const COMMODITY = 'commodity'; - /** @var string Подакцизный товар */ + /** Подакцизный товар */ const EXCISE = 'excise'; - /** @var string Работа */ + /** Работа */ const JOB = 'job'; - /** @var string Услуга */ + /** Услуга */ const SERVICE = 'service'; - /** @var string Ставка в азартной игре */ + /** Ставка в азартной игре */ const GAMBLING_BET = 'gambling_bet'; - /** @var string Выигрыш азартной игры */ + /** Выигрыш азартной игры */ const GAMBLING_PRIZE = 'gambling_prize'; - /** @var string Лотерейный билет */ + /** Лотерейный билет */ const LOTTERY = 'lottery'; - /** @var string Выигрыш в лотерею */ + /** Выигрыш в лотерею */ const LOTTERY_PRIZE = 'lottery_prize'; - /** @var string Результаты интеллектуальной деятельности */ + /** Результаты интеллектуальной деятельности */ const INTELLECTUAL_ACTIVITY = 'intellectual_activity'; - /** @var string Платеж */ + /** Платеж */ const PAYMENT = 'payment'; - /** @var string Агентское вознаграждение */ + /** Агентское вознаграждение */ const AGENT_COMMISSION = 'agent_commission'; - /** @var string Имущественное право */ + /** Имущественное право */ const PROPERTY_RIGHT = 'property_right'; - /** @var string Внереализационный доход */ + /** Внереализационный доход */ const NON_OPERATING_GAIN = 'non_operating_gain'; - /** @var string Страховой сбор */ + /** Страховой сбор */ const INSURANCE_PREMIUM = 'insurance_premium'; - /** @var string Торговый сбор */ + /** Торговый сбор */ const SALES_TAX = 'sales_tax'; - /** @var string Курортный сбор */ + /** Курортный сбор */ const RESORT_FEE = 'resort_fee'; - /** @var string Несколько вариантов */ + /** Несколько вариантов */ const COMPOSITE = 'composite'; - /** @var string Другое */ + /** Другое */ const ANOTHER = 'another'; - /** @var string Выплата */ + /** Выплата */ const FINE = 'fine'; - /** @var string Страховые взносы */ + /** Страховые взносы */ const TAX = 'tax'; - /** @var string Залог */ + /** Залог */ const LIEN = 'lien'; - /** @var string Расход */ + /** Расход */ const COST = 'cost'; - /** @var string Взносы на обязательное пенсионное страхование ИП */ + /** Взносы на обязательное пенсионное страхование ИП */ const PENSION_INSURANCE_WITHOUT_PAYOUTS = 'pension_insurance_without_payouts'; - /** @var string Взносы на обязательное пенсионное страхование */ + /** Взносы на обязательное пенсионное страхование */ const PENSION_INSURANCE_WITH_PAYOUTS = 'pension_insurance_with_payouts'; - /** @var string Взносы на обязательное медицинское страхование ИП */ + /** Взносы на обязательное медицинское страхование ИП */ const HEALTH_INSURANCE_WITHOUT_PAYOUTS = 'health_insurance_without_payouts'; - /** @var string Взносы на обязательное медицинское страхование */ + /** Взносы на обязательное медицинское страхование */ const HEALTH_INSURANCE_WITH_PAYOUTS = 'health_insurance_with_payouts'; - /** @var string Взносы на обязательное социальное страхование */ + /** Взносы на обязательное социальное страхование */ const HEALTH_INSURANCE = 'health_insurance'; - /** @var string Платеж казино */ + /** Платеж казино */ const CASINO = 'casino'; - /** @var string Выдача денежных средств */ + /** Выдача денежных средств */ const AGENT_WITHDRAWALS = 'agent_withdrawals'; - /** @var string Подакцизный товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки (в чеке — АТНМ). Пример: алкогольная продукция */ + /** Подакцизный товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки (в чеке — АТНМ). Пример: алкогольная продукция */ const NON_MARKED_EXCISE = 'non_marked_excise'; - /** @var string Подакцизный товар, подлежащий маркировке средством идентификации, имеющим код маркировки (в чеке — АТМ). Пример: табак */ + /** Подакцизный товар, подлежащий маркировке средством идентификации, имеющим код маркировки (в чеке — АТМ). Пример: табак */ const MARKED_EXCISE = 'marked_excise'; - /** @var string Товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара (в чеке — ТМ). Пример: обувь, духи, товары легкой промышленности */ + /** Товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара (в чеке — ТМ). Пример: обувь, духи, товары легкой промышленности */ const MARKED = 'marked'; - /** @var string Товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки, за исключением подакцизного товара (в чеке — ТНМ). Пример: меховые изделия */ + /** Товар, подлежащий маркировке средством идентификации, не имеющим кода маркировки, за исключением подакцизного товара (в чеке — ТНМ). Пример: меховые изделия */ const NON_MARKED = 'non_marked'; protected static $validValues = array( diff --git a/lib/Model/Receipt/ReceiptItemAmount.php b/lib/Model/Receipt/ReceiptItemAmount.php index e53e64af..d667a926 100644 --- a/lib/Model/Receipt/ReceiptItemAmount.php +++ b/lib/Model/Receipt/ReceiptItemAmount.php @@ -1,8 +1,9 @@ _value = $castedValue; } @@ -145,7 +145,10 @@ class ReceiptItemAmount extends AbstractObject implements AmountInterface $this->_currency = $value; } else { throw new InvalidPropertyValueException( - 'Invalid currency value: "' . $value . '"', 0, 'amount.currency', $value + 'Invalid currency value: "' . $value . '"', + 0, + 'amount.currency', + $value ); } } else { @@ -169,18 +172,27 @@ class ReceiptItemAmount extends AbstractObject implements AmountInterface } if (!is_numeric($coefficient)) { throw new InvalidPropertyValueTypeException( - 'Invalid coefficient type in multiply method', 0, 'amount.value', $coefficient + 'Invalid coefficient type in multiply method', + 0, + 'amount.value', + $coefficient ); } if ($coefficient <= 0.0) { throw new InvalidPropertyValueException( - 'Invalid coefficient in multiply method: "' . $coefficient . '"', 0, 'amount.value', $coefficient + 'Invalid coefficient in multiply method: "' . $coefficient . '"', + 0, + 'amount.value', + $coefficient ); } $castedValue = (int)round($coefficient * $this->_value); if ($castedValue === 0) { throw new InvalidPropertyValueException( - 'Invalid coefficient value in multiply method: "' . $coefficient . '"', 0, 'amount.value', $coefficient + 'Invalid coefficient value in multiply method: "' . $coefficient . '"', + 0, + 'amount.value', + $coefficient ); } $this->_value = $castedValue; @@ -201,13 +213,19 @@ class ReceiptItemAmount extends AbstractObject implements AmountInterface } if (!is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid amount value type in increase method', 0, 'amount.value', $value + 'Invalid amount value type in increase method', + 0, + 'amount.value', + $value ); } $castedValue = (int)round($this->_value + $value * 100.0); if ($castedValue <= 0) { throw new InvalidPropertyValueException( - 'Invalid amount value in increase method: "' . $value . '"', 0, 'amount.value', $value + 'Invalid amount value in increase method: "' . $value . '"', + 0, + 'amount.value', + $value ); } $this->_value = $castedValue; diff --git a/lib/Model/Receipt/ReceiptItemMeasure.php b/lib/Model/Receipt/ReceiptItemMeasure.php index 1e139087..b64f3e76 100644 --- a/lib/Model/Receipt/ReceiptItemMeasure.php +++ b/lib/Model/Receipt/ReceiptItemMeasure.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -34,53 +34,53 @@ use YooKassa\Common\AbstractEnum; */ class ReceiptItemMeasure extends AbstractEnum { - /** @var string Штука, единица товара */ + /** Штука, единица товара */ const PIECE = 'piece'; - /** @var string Грамм */ + /** Грамм */ const GRAM = 'gram'; - /** @var string Килограмм */ + /** Килограмм */ const KILOGRAM = 'kilogram'; - /** @var string Тонна */ + /** Тонна */ const TON = 'ton'; - /** @var string Сантиметр */ + /** Сантиметр */ const CENTIMETER = 'centimeter'; - /** @var string Дециметр */ + /** Дециметр */ const DECIMETER = 'decimeter'; - /** @var string Метр */ + /** Метр */ const METER = 'meter'; - /** @var string Квадратный сантиметр */ + /** Квадратный сантиметр */ const SQUARE_CENTIMETER = 'square_centimeter'; - /** @var string Квадратный дециметр */ + /** Квадратный дециметр */ const SQUARE_DECIMETER = 'square_decimeter'; - /** @var string Квадратный метр */ + /** Квадратный метр */ const SQUARE_METER = 'square_meter'; - /** @var string Миллилитр */ + /** Миллилитр */ const MILLILITER = 'milliliter'; - /** @var string Литр */ + /** Литр */ const LITER = 'liter'; - /** @var string Кубический метр */ + /** Кубический метр */ const CUBIC_METER = 'cubic_meter'; - /** @var string Килловат-час */ + /** Килловат-час */ const KILOWATT_HOUR = 'kilowatt_hour'; - /** @var string Гигакалория */ + /** Гигакалория */ const GIGACALORIE = 'gigacalorie'; - /** @var string Сутки */ + /** Сутки */ const DAY = 'day'; - /** @var string Час */ + /** Час */ const HOUR = 'hour'; - /** @var string Минута */ + /** Минута */ const MINUTE = 'minute'; - /** @var string Секунда */ + /** Секунда */ const SECOND = 'second'; - /** @var string Килобайт */ + /** Килобайт */ const KILOBYTE = 'kilobyte'; - /** @var string Мегабайт */ + /** Мегабайт */ const MEGABYTE = 'megabyte'; - /** @var string Гигабайт */ + /** Гигабайт */ const GIGABYTE = 'gigabyte'; - /** @var string Терабайт */ + /** Терабайт */ const TERABYTE = 'terabyte'; - /** @var string Другое */ + /** Другое */ const ANOTHER = 'another'; protected static $validValues = array( diff --git a/lib/Model/Receipt/SettlementType.php b/lib/Model/Receipt/SettlementType.php index 1cdbd9f7..be61cfee 100644 --- a/lib/Model/Receipt/SettlementType.php +++ b/lib/Model/Receipt/SettlementType.php @@ -1,8 +1,9 @@ 256) { throw new InvalidPropertyValueException( - 'Invalid full_name value: "'.$value.'"', 0, 'receipt.customer.full_name', $value + 'Invalid full_name value: "' . $value . '"', + 0, + 'receipt.customer.full_name', + $value ); } else { $this->_fullName = (string)$value; @@ -172,7 +175,7 @@ class ReceiptCustomer extends AbstractObject implements ReceiptCustomerInterface } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException('Invalid inn value type', 0, 'receipt.customer.inn'); } elseif (!preg_match('/^([0-9]{10}|[0-9]{12})$/', (string)$value)) { - throw new InvalidPropertyValueException('Invalid inn value: "'.$value.'"', 0, 'receipt.customer.inn'); + throw new InvalidPropertyValueException('Invalid inn value: "' . $value . '"', 0, 'receipt.customer.inn'); } else { $this->_inn = (string)$value; } @@ -214,5 +217,4 @@ class ReceiptCustomer extends AbstractObject implements ReceiptCustomerInterface return $result; } - } diff --git a/lib/Model/ReceiptCustomerInterface.php b/lib/Model/ReceiptCustomerInterface.php index 11bf6475..32def7a1 100644 --- a/lib/Model/ReceiptCustomerInterface.php +++ b/lib/Model/ReceiptCustomerInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -44,33 +44,33 @@ interface ReceiptCustomerInterface * * @return string Название организации или ФИО физического лица */ - function getFullName(); + public function getFullName(); /** * Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек * * @return string Номер телефона плательщика */ - function getPhone(); + public function getPhone(); /** * Возвращает адрес электронной почты на который будет выслан чек * * @return string E-mail адрес плательщика */ - function getEmail(); + public function getEmail(); /** * Возвращает ИНН плательщика * * @return string ИНН плательщика */ - function getInn(); + public function getInn(); /** * Возвращает массив полей плательщика * * @return array */ - function jsonSerialize(); + public function jsonSerialize(); } diff --git a/lib/Model/ReceiptInterface.php b/lib/Model/ReceiptInterface.php index cb34b0bc..a647934a 100644 --- a/lib/Model/ReceiptInterface.php +++ b/lib/Model/ReceiptInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/ReceiptItem.php b/lib/Model/ReceiptItem.php index 7063b8d0..c7cf38f4 100644 --- a/lib/Model/ReceiptItem.php +++ b/lib/Model/ReceiptItem.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/ReceiptItemInterface.php b/lib/Model/ReceiptItemInterface.php index 624a7542..da9717d0 100644 --- a/lib/Model/ReceiptItemInterface.php +++ b/lib/Model/ReceiptItemInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/ReceiptRegistrationStatus.php b/lib/Model/ReceiptRegistrationStatus.php index 155b09e3..012a876a 100644 --- a/lib/Model/ReceiptRegistrationStatus.php +++ b/lib/Model/ReceiptRegistrationStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,27 +32,17 @@ use YooKassa\Common\AbstractEnum; * Класс с перечислением статусов доставки данных для чека в онлайн-кассу (`pending`, `succeeded` или `canceled`) * * Состояние регистрации фискального чека: - * + * - `pending` - Чек ожидает доставки + * - `succeeded` - Успешно доставлен + * - `canceled` - Чек не доставлен */ class ReceiptRegistrationStatus extends AbstractEnum { - /** - * @var string Состояние регистрации фискального чека: ожидает доставки - */ + /** Состояние регистрации фискального чека: ожидает доставки */ const PENDING = 'pending'; - - /** - * @var string Состояние регистрации фискального чека: успешно доставлен - */ + /** Состояние регистрации фискального чека: успешно доставлен */ const SUCCEEDED = 'succeeded'; - - /** - * @var string Состояние регистрации фискального чека: не доставлен - */ + /** Состояние регистрации фискального чека: не доставлен */ const CANCELED = 'canceled'; protected static $validValues = array( diff --git a/lib/Model/ReceiptType.php b/lib/Model/ReceiptType.php index 35766e4a..c719dd23 100644 --- a/lib/Model/ReceiptType.php +++ b/lib/Model/ReceiptType.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,21 +30,19 @@ use YooKassa\Common\AbstractEnum; /** * ReceiptType - Тип чека в онлайн-кассе. - * |Код|Описание| - * --- | --- - * |payment|Приход| - * |refund|Возврат| - * |simple|Простой| + * + * Возможные значения: + * - `payment` - Приход + * - `refund` - Возврат + * - `simple` - Простой */ class ReceiptType extends AbstractEnum { - /** @var string Тип чека: приход */ + /** Тип чека: приход */ const PAYMENT = 'payment'; - - /** @var string Тип чека: возврат */ + /** Тип чека: возврат */ const REFUND = 'refund'; - - /** @var string Тип чека: простой */ + /** Тип чека: простой */ const SIMPLE = 'simple'; protected static $validValues = array( diff --git a/lib/Model/Recipient.php b/lib/Model/Recipient.php index 9af46d6c..b510706a 100644 --- a/lib/Model/Recipient.php +++ b/lib/Model/Recipient.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -80,7 +80,10 @@ class Recipient extends AbstractObject implements RecipientInterface $this->_accountId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid accountId value type in Recipient', 0, 'Recipient.accountId', $value + 'Invalid accountId value type in Recipient', + 0, + 'Recipient.accountId', + $value ); } } @@ -109,13 +112,18 @@ class Recipient extends AbstractObject implements RecipientInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty gatewayId value in Recipient', 0, 'Recipient.gatewayId' + 'Empty gatewayId value in Recipient', + 0, + 'Recipient.gatewayId' ); } elseif (TypeCast::canCastToString($value)) { $this->_gatewayId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid gatewayId value type in Recipient', 0, 'Recipient.gatewayId', $value + 'Invalid gatewayId value type in Recipient', + 0, + 'Recipient.gatewayId', + $value ); } } diff --git a/lib/Model/RecipientInterface.php b/lib/Model/RecipientInterface.php index fbeb2fb7..f3fbccb8 100644 --- a/lib/Model/RecipientInterface.php +++ b/lib/Model/RecipientInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -44,7 +44,7 @@ interface RecipientInterface * * @return string Идентификатор магазина */ - function getAccountId(); + public function getAccountId(); /** * Возвращает идентификатор шлюза. @@ -53,5 +53,5 @@ interface RecipientInterface * * @return string Идентификатор шлюза */ - function getGatewayId(); + public function getGatewayId(); } diff --git a/lib/Model/Refund.php b/lib/Model/Refund.php index afb64e18..305f5dc9 100644 --- a/lib/Model/Refund.php +++ b/lib/Model/Refund.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -157,12 +157,18 @@ class Refund extends AbstractObject implements RefundInterface $this->_paymentId = $castedValue; } else { throw new InvalidPropertyValueException( - 'Invalid refund paymentId value', 0, 'Refund.paymentId', $value + 'Invalid refund paymentId value', + 0, + 'Refund.paymentId', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid refund paymentId value type', 0, 'Refund.paymentId', $value + 'Invalid refund paymentId value type', + 0, + 'Refund.paymentId', + $value ); } } @@ -194,12 +200,18 @@ class Refund extends AbstractObject implements RefundInterface $this->_status = $castedValue; } else { throw new InvalidPropertyValueException( - 'Invalid refund status value', 0, 'Refund.status', $value + 'Invalid refund status value', + 0, + 'Refund.status', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid refund status value type', 0, 'Refund.status', $value + 'Invalid refund status value type', + 0, + 'Refund.status', + $value ); } } @@ -287,12 +299,18 @@ class Refund extends AbstractObject implements RefundInterface $this->_receiptRegistration = $castedValue; } else { throw new InvalidPropertyValueException( - 'Invalid refund receiptRegistration value', 0, 'Refund.receiptRegistration', $value + 'Invalid refund receiptRegistration value', + 0, + 'Refund.receiptRegistration', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid refund receiptRegistration value type', 0, 'Refund.receiptRegistration', $value + 'Invalid refund receiptRegistration value type', + 0, + 'Refund.receiptRegistration', + $value ); } } @@ -371,7 +389,8 @@ class Refund extends AbstractObject implements RefundInterface * @deprecated Не используется. Будет удален в следующих версиях */ public function setRequestor($value) - {} + { + } /** * Возвращает данные о сделке, в составе которой проходит возврат @@ -398,9 +417,11 @@ class Refund extends AbstractObject implements RefundInterface $this->_deal = new RefundDealInfo($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal value type in Refund', 0, 'Refund.deal', $value + 'Invalid deal value type in Refund', + 0, + 'Refund.deal', + $value ); } } - } diff --git a/lib/Model/RefundInterface.php b/lib/Model/RefundInterface.php index 20cbb71a..190cc5c6 100644 --- a/lib/Model/RefundInterface.php +++ b/lib/Model/RefundInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -51,49 +51,49 @@ interface RefundInterface * Возвращает идентификатор возврата платежа * @return string Идентификатор возврата */ - function getId(); + public function getId(); /** * Возвращает идентификатор платежа * @return string Идентификатор платежа */ - function getPaymentId(); + public function getPaymentId(); /** * Возвращает статус текущего возврата * @return string Статус возврата */ - function getStatus(); + public function getStatus(); /** * Возвращает дату создания возврата * @return \DateTime Время создания возврата */ - function getCreatedAt(); + public function getCreatedAt(); /** * Возвращает сумму возврата * @return AmountInterface Сумма возврата */ - function getAmount(); + public function getAmount(); /** * Возвращает статус регистрации чека * @return string Статус регистрации чека */ - function getReceiptRegistration(); + public function getReceiptRegistration(); /** * Возвращает комментарий к возврату * @return string Комментарий, основание для возврата средств покупателю */ - function getDescription(); + public function getDescription(); /** * Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести * @return SourceInterface[] */ - function getSources(); + public function getSources(); /** * Возвращает сделку, в рамках которой нужно провести возврат. diff --git a/lib/Model/RefundStatus.php b/lib/Model/RefundStatus.php index 8684a5fc..6dbdcd5c 100644 --- a/lib/Model/RefundStatus.php +++ b/lib/Model/RefundStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -30,12 +30,11 @@ use YooKassa\Common\AbstractEnum; /** * RefundStatus - Состояние возврата платежа - * |Код|Описание| - * --- | --- - * |pending|Ожидает обработки| - * |succeeded|Успешно возвращен| - * |canceled|В проведении возврата отказано| * + * Возможные значения: + * - `pending` - Ожидает обработки + * - `succeeded` - Успешно возвращен + * - `canceled` - В проведении возврата отказано */ class RefundStatus extends AbstractEnum { diff --git a/lib/Model/Requestor.php b/lib/Model/Requestor.php index 2d34cf8e..ac48a6b0 100644 --- a/lib/Model/Requestor.php +++ b/lib/Model/Requestor.php @@ -1,9 +1,31 @@ _type = (string)$value; @@ -86,7 +112,9 @@ class Requestor extends AbstractObject implements RequestorInterface $this->_accountId = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "accountId" parameter in Source', 0, 'source.accountId' + 'Invalid value type for "accountId" parameter in Source', + 0, + 'source.accountId' ); } else { $this->_accountId = (string)$value; @@ -112,7 +140,9 @@ class Requestor extends AbstractObject implements RequestorInterface $this->_clientId = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "accountId" parameter in Source', 0, 'source.accountId' + 'Invalid value type for "accountId" parameter in Source', + 0, + 'source.accountId' ); } else { $this->_clientId = (string)$value; @@ -138,7 +168,9 @@ class Requestor extends AbstractObject implements RequestorInterface $this->_clientName = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "accountId" parameter in Source', 0, 'source.accountId' + 'Invalid value type for "accountId" parameter in Source', + 0, + 'source.accountId' ); } else { $this->_clientName = (string)$value; @@ -153,4 +185,4 @@ class Requestor extends AbstractObject implements RequestorInterface { return $this->_clientName; } -} \ No newline at end of file +} diff --git a/lib/Model/RequestorInterface.php b/lib/Model/RequestorInterface.php index f5055633..5c5d9ed4 100644 --- a/lib/Model/RequestorInterface.php +++ b/lib/Model/RequestorInterface.php @@ -1,5 +1,28 @@ _balance->fromArray($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid SafeDeal.balance value type', 0, 'SafeDeal.balance', $value + 'Invalid SafeDeal.balance value type', + 0, + 'SafeDeal.balance', + $value ); } return $this; @@ -183,7 +186,10 @@ class SafeDeal extends BaseDeal implements DealInterface $this->_payout_balance->fromArray($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid SafeDeal.payout_balance value type', 0, 'SafeDeal.payout_balance', $value + 'Invalid SafeDeal.payout_balance value type', + 0, + 'SafeDeal.payout_balance', + $value ); } return $this; @@ -212,7 +218,10 @@ class SafeDeal extends BaseDeal implements DealInterface $this->_status = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal status value type', 0, 'SafeDeal.status', $value + 'Invalid deal status value type', + 0, + 'SafeDeal.status', + $value ); } return $this; @@ -310,7 +319,10 @@ class SafeDeal extends BaseDeal implements DealInterface $this->_test = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid SafeDeal test flag value type', 0, 'SafeDeal.test', $value + 'Invalid SafeDeal test flag value type', + 0, + 'SafeDeal.test', + $value ); } return $this; @@ -350,7 +362,10 @@ class SafeDeal extends BaseDeal implements DealInterface $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'SafeDeal.description', $value + 'Invalid description value type', + 0, + 'SafeDeal.description', + $value ); } return $this; @@ -380,7 +395,10 @@ class SafeDeal extends BaseDeal implements DealInterface $this->_metadata = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "metadata" parameter in SafeDeal', 0, 'SafeDeal.metadata', $value + 'Invalid value type for "metadata" parameter in SafeDeal', + 0, + 'SafeDeal.metadata', + $value ); } return $this; diff --git a/lib/Model/SelfEmployed/SelfEmployed.php b/lib/Model/SelfEmployed/SelfEmployed.php new file mode 100644 index 00000000..8149d8ab --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployed.php @@ -0,0 +1,334 @@ +_id; + } + + /** + * Устанавливает идентификатор самозанятого. + * + * @param string $id Идентификатор самозанятого в ЮKassa. + * + * @return $this + */ + public function setId($id) + { + if (!TypeCast::canCastToString($id)) { + throw new InvalidPropertyValueTypeException('Invalid SelfEmployed id value type', 0, 'SelfEmployed.id', $id); + } + $length = mb_strlen($id, 'utf-8'); + if ($length < SelfEmployedInterface::MIN_LENGTH_ID || $length > SelfEmployedInterface::MAX_LENGTH_ID) { + throw new InvalidPropertyValueException('Invalid SelfEmployed id value', 0, 'SelfEmployed.id', $id); + } + $this->_id = (string)$id; + + return $this; + } + + /** + * Возвращает статус самозанятого. + * + * @return string Статус самозанятого + */ + public function getStatus() + { + return $this->_status; + } + + /** + * Устанавливает статус самозанятого. + * + * @param string $status Статус самозанятого + * + * @return $this + */ + public function setStatus($status) + { + if (!TypeCast::canCastToEnumString($status)) { + throw new InvalidPropertyValueTypeException( + 'Invalid SelfEmployedS status value type', + 0, + 'SelfEmployedS.status', + $status + ); + } + if (!SelfEmployedStatus::valueExists((string)$status)) { + throw new InvalidPropertyValueException('Invalid SelfEmployedS status value', 0, 'SelfEmployedS.status', $status); + } + $this->_status = (string)$status; + + return $this; + } + + /** + * Возвращает время создания объекта самозанятого + * + * @return DateTime Время создания объекта самозанятого + */ + public function getCreatedAt() + { + return $this->_created_at; + } + + /** + * Устанавливает время создания объекта самозанятого + * + * @param DateTime|string|int $created_at Время создания объекта самозанятого + * + * @return $this + * + * @throws EmptyPropertyValueException Выбрасывается если в метод была передана пустая дата + * @throws InvalidPropertyValueException Выбрасывается если передали строку, которую не удалось привести к дате + * @throws InvalidPropertyValueTypeException|\Exception Выбрасывается если был передан аргумент, который невозможно + * интерпретировать как дату или время + */ + public function setCreatedAt($created_at) + { + if ($created_at === null || $created_at === '') { + throw new EmptyPropertyValueException('Empty created_at value', 0, 'SelfEmployed.createdAt'); + } + if (!TypeCast::canCastToDateTime($created_at)) { + throw new InvalidPropertyValueTypeException('Invalid created_at value', 0, 'SelfEmployed.createdAt', $created_at); + } + $dateTime = TypeCast::castToDateTime($created_at); + if ($dateTime === null) { + throw new InvalidPropertyValueException('Invalid created_at value', 0, 'SelfEmployed.createdAt', $created_at); + } + $this->_created_at = $dateTime; + + return $this; + } + + /** + * Возвращает ИНН самозанятого + * + * @return string|null ИНН самозанятого + */ + public function getItn() + { + return $this->_itn; + } + + /** + * Устанавливает ИНН самозанятого + * + * @param string|null $itn ИНН самозанятого + * + * @return $this + */ + public function setItn($itn = null) + { + if ($itn === null || $itn === '') { + $this->_itn = null; + } elseif (!TypeCast::canCastToString($itn)) { + throw new InvalidPropertyValueTypeException('Invalid itn value type', 0, 'SelfEmployed.itn'); + } else { + $this->_itn = (string)preg_replace('/\D/', '', $itn); + } + + return $this; + } + + /** + * Возвращает телефон самозанятого. + * + * @return string|null Телефон самозанятого + */ + public function getPhone() + { + return $this->_phone; + } + + /** + * Устанавливает телефон самозанятого. + * + * @param string|null $phone Телефон самозанятого + * + * @return $this + */ + public function setPhone($phone = null) + { + if ($phone === null || $phone === '') { + $this->_phone = null; + } elseif (!TypeCast::canCastToString($phone)) { + throw new InvalidPropertyValueTypeException('Invalid phone value type', 0, 'SelfEmployed.phone'); + } else { + $this->_phone = (string)preg_replace('/\D/', '', $phone); + } + + return $this; + } + + /** + * Возвращает сценарий подтверждения. + * + * @return SelfEmployedConfirmation|null Сценарий подтверждения + */ + public function getConfirmation() + { + return $this->_confirmation; + } + + /** + * Устанавливает сценарий подтверждения. + * + * @param SelfEmployedConfirmation|array|null $confirmation Сценарий подтверждения + * + * @return $this + */ + public function setConfirmation($confirmation = null) + { + if ($confirmation === null || $confirmation === '') { + $this->_confirmation = null; + } elseif (is_array($confirmation)) { + $factory = new SelfEmployedConfirmationFactory(); + $this->_confirmation = $factory->factoryFromArray($confirmation); + } elseif ($confirmation instanceof SelfEmployedConfirmation) { + $this->_confirmation = $confirmation; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "confirmation" parameter in SelfEmployed', + 0, + 'SelfEmployed.confirmation', + $confirmation + ); + } + + return $this; + } + + /** + * Возвращает признак тестовой операции. + * + * @return bool Признак тестовой операции. + */ + public function getTest() + { + return $this->_test; + } + + /** + * Устанавливает признак тестовой операции. + * + * @param bool $test Признак тестовой операции. + * + * @return $this + */ + public function setTest($test) + { + if ($test === null || $test === '') { + throw new EmptyPropertyValueException('Empty SelfEmployed test flag value', 0, 'SelfEmployed.test'); + } + if (!TypeCast::canCastToBoolean($test)) { + throw new InvalidPropertyValueTypeException( + 'Invalid SelfEmployed test flag value type', + 0, + 'SelfEmployed.test', + $test + ); + } + $this->_test = (bool)$test; + + return $this; + } +} diff --git a/lib/Model/SelfEmployed/SelfEmployedConfirmation.php b/lib/Model/SelfEmployed/SelfEmployedConfirmation.php new file mode 100644 index 00000000..e42df20e --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployedConfirmation.php @@ -0,0 +1,91 @@ +_type; + } + + /** + * Устанавливает тип сценария подтверждения + * @param string $value + */ + protected function setType($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException( + 'Empty value for "type" parameter in SelfEmployedConfirmation', + 0, + 'confirmation.type' + ); + } + if (!TypeCast::canCastToEnumString($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "type" parameter in SelfEmployedConfirmation', + 0, + 'confirmation.type', + $value + ); + } + if (!SelfEmployedConfirmationType::valueExists($value)) { + throw new InvalidPropertyValueException( + 'Invalid value for "type" parameter in SelfEmployedConfirmation', + 0, + 'confirmation.type', + $value + ); + } + $this->_type = (string)$value; + } +} diff --git a/lib/Model/SelfEmployed/SelfEmployedConfirmationFactory.php b/lib/Model/SelfEmployed/SelfEmployedConfirmationFactory.php new file mode 100644 index 00000000..5b031334 --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployedConfirmationFactory.php @@ -0,0 +1,89 @@ + 'SelfEmployedConfirmationRedirect', + ); + + /** + * Возвращает объект, соответствующий типу подтверждения платежа + * + * @param string $type Тип подтверждения платежа + * + * @return SelfEmployedConfirmation + */ + public function factory($type) + { + if (!is_string($type)) { + throw new \InvalidArgumentException('Invalid confirmation value in confirmation factory'); + } + if (!array_key_exists($type, $this->typeClassMap)) { + throw new \InvalidArgumentException('Invalid confirmation value type "' . $type . '"'); + } + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; + + return new $className(); + } + + /** + * Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + * + * @param array $data Массив данных подтверждения платежа + * @param string|null $type Тип подтверждения платежа + * + * @return SelfEmployedConfirmation + */ + public function factoryFromArray(array $data, $type = null) + { + if ($type === null) { + if (array_key_exists('type', $data)) { + $type = $data['type']; + unset($data['type']); + } else { + throw new \InvalidArgumentException( + 'Parameter type not specified in SelfEmployedConfirmation.factoryFromArray()' + ); + } + } + $confirmation = $this->factory($type); + foreach ($data as $key => $value) { + if ($confirmation->offsetExists($key)) { + $confirmation->offsetSet($key, $value); + } + } + + return $confirmation; + } +} diff --git a/lib/Model/SelfEmployed/SelfEmployedConfirmationRedirect.php b/lib/Model/SelfEmployed/SelfEmployedConfirmationRedirect.php new file mode 100644 index 00000000..e81e1fa7 --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployedConfirmationRedirect.php @@ -0,0 +1,86 @@ +setType(SelfEmployedConfirmationType::REDIRECT); + } + + /** + * Возвращает confirmation_url. + * + * @return string|null + */ + public function getConfirmationUrl() + { + return $this->_confirmation_url; + } + + /** + * Устанавливает confirmation_url. + * + * @param string|null $confirmation_url URL, на который необходимо перенаправить самозанятого для выдачи прав. + * + * @return $this + */ + public function setConfirmationUrl($confirmation_url) + { + if ($confirmation_url === null || $confirmation_url === '') { + $this->_confirmation_url = null; + } elseif (!TypeCast::canCastToString($confirmation_url)) { + throw new InvalidPropertyValueTypeException('Invalid confirmation_url value type', 0, 'SelfEmployedConfirmationRedirect.confirmation_url'); + } else { + $this->_confirmation_url = $confirmation_url; + } + + return $this; + } +} diff --git a/lib/Model/SelfEmployed/SelfEmployedConfirmationType.php b/lib/Model/SelfEmployed/SelfEmployedConfirmationType.php new file mode 100644 index 00000000..adb9624a --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployedConfirmationType.php @@ -0,0 +1,50 @@ + true, + ); +} diff --git a/lib/Model/SelfEmployed/SelfEmployedInterface.php b/lib/Model/SelfEmployed/SelfEmployedInterface.php new file mode 100644 index 00000000..ea528e9a --- /dev/null +++ b/lib/Model/SelfEmployed/SelfEmployedInterface.php @@ -0,0 +1,174 @@ + true, + self::CONFIRMED => true, + self::CANCELED => true, + ); +} diff --git a/lib/Model/Settlement.php b/lib/Model/Settlement.php index da77aaed..f35fdb0c 100644 --- a/lib/Model/Settlement.php +++ b/lib/Model/Settlement.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - use YooKassa\Common\AbstractObject; use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; @@ -70,19 +69,27 @@ class Settlement extends AbstractObject implements SettlementInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "type" parameter in Settlement', 0, 'settlement.type' + 'Empty value for "type" parameter in Settlement', + 0, + 'settlement.type' ); } elseif (TypeCast::canCastToEnumString($value)) { if (SettlementType::valueExists($value)) { $this->_type = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid value for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "type" parameter in Settlement', 0, 'settlement.type', $value + 'Invalid value type for "type" parameter in Settlement', + 0, + 'settlement.type', + $value ); } } @@ -104,7 +111,9 @@ class Settlement extends AbstractObject implements SettlementInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "amount" parameter in Settlement', 0, 'settlement.amount' + 'Empty value for "amount" parameter in Settlement', + 0, + 'settlement.amount' ); } elseif (is_array($value)) { $this->_amount = $this->factoryAmount($value); @@ -112,7 +121,10 @@ class Settlement extends AbstractObject implements SettlementInterface $this->_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "amount" parameter in Settlement', 0, 'settlement.amount', $value + 'Invalid value type for "amount" parameter in Settlement', + 0, + 'settlement.amount', + $value ); } } diff --git a/lib/Model/SettlementInterface.php b/lib/Model/SettlementInterface.php index 0d15e03d..7b8fe448 100644 --- a/lib/Model/SettlementInterface.php +++ b/lib/Model/SettlementInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -40,11 +40,11 @@ interface SettlementInterface * Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) * @return string Вид оплаты в чеке */ - function getType(); + public function getType(); /** * Возвращает размер оплаты * @return AmountInterface Размер оплаты */ - function getAmount(); + public function getAmount(); } diff --git a/lib/Model/Source.php b/lib/Model/Source.php index a5244e93..94e40eba 100644 --- a/lib/Model/Source.php +++ b/lib/Model/Source.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -62,11 +62,15 @@ class Source extends AbstractObject implements SourceInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "accountId" parameter in Source', 0, 'source.accountId' + 'Empty value for "accountId" parameter in Source', + 0, + 'source.accountId' ); } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "accountId" parameter in Source', 0, 'source.accountId' + 'Invalid value type for "accountId" parameter in Source', + 0, + 'source.accountId' ); } else { $this->_accountId = (string)$value; @@ -104,7 +108,9 @@ class Source extends AbstractObject implements SourceInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "amount" parameter in Source', 0, 'source.amount' + 'Empty value for "amount" parameter in Source', + 0, + 'source.amount' ); } elseif (is_array($value)) { $this->_amount = $this->factoryAmount($value); @@ -112,7 +118,10 @@ class Source extends AbstractObject implements SourceInterface $this->_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "amount" parameter in Source', 0, 'source.amount', $value + 'Invalid value type for "amount" parameter in Source', + 0, + 'source.amount', + $value ); } } @@ -140,7 +149,9 @@ class Source extends AbstractObject implements SourceInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "platform_fee_amount" parameter in Source', 0, 'source.platform_fee_amount' + 'Empty value for "platform_fee_amount" parameter in Source', + 0, + 'source.platform_fee_amount' ); } elseif (is_array($value)) { $this->_platform_fee_amount = $this->factoryAmount($value); @@ -148,7 +159,10 @@ class Source extends AbstractObject implements SourceInterface $this->_platform_fee_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "platform_fee_amount" parameter in Source', 0, 'source.platform_fee_amount', $value + 'Invalid value type for "platform_fee_amount" parameter in Source', + 0, + 'source.platform_fee_amount', + $value ); } } diff --git a/lib/Model/SourceInterface.php b/lib/Model/SourceInterface.php index 99d6381f..8a610ea0 100644 --- a/lib/Model/SourceInterface.php +++ b/lib/Model/SourceInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Model/Supplier.php b/lib/Model/Supplier.php index e1375244..41c5c170 100644 --- a/lib/Model/Supplier.php +++ b/lib/Model/Supplier.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model; - use YooKassa\Common\AbstractObject; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -116,7 +115,7 @@ class Supplier extends AbstractObject implements SupplierInterface } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException('Invalid inn value type', 0, 'receipt.supplier.inn'); } elseif (!preg_match('/^([0-9]{10}|[0-9]{12})$/', (string)$value)) { - throw new InvalidPropertyValueException('Invalid inn value: "'.$value.'"', 0, 'receipt.supplier.inn'); + throw new InvalidPropertyValueException('Invalid inn value: "' . $value . '"', 0, 'receipt.supplier.inn'); } else { $this->_inn = (string)$value; } diff --git a/lib/Model/SupplierInterface.php b/lib/Model/SupplierInterface.php index 0e23c7b1..8eef833e 100644 --- a/lib/Model/SupplierInterface.php +++ b/lib/Model/SupplierInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -73,7 +73,7 @@ interface SupplierInterface /** * Устанавливает ИНН пользователя (10 или 12 цифр) - * @param $value ИНН пользователя + * @param string|null $value ИНН пользователя */ public function setInn($value); } diff --git a/lib/Model/ThreeDSecure.php b/lib/Model/ThreeDSecure.php index 3932b9aa..b220a477 100644 --- a/lib/Model/ThreeDSecure.php +++ b/lib/Model/ThreeDSecure.php @@ -1,5 +1,29 @@ _applied = (bool)$value; } -} \ No newline at end of file +} diff --git a/lib/Model/Transfer.php b/lib/Model/Transfer.php index c99513b6..aa2db355 100644 --- a/lib/Model/Transfer.php +++ b/lib/Model/Transfer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -43,7 +43,7 @@ use YooKassa\Helpers\TypeCast; * @property string $accountId Идентификатор магазина, в пользу которого вы принимаете оплату * @property string $status Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` * @property string $description Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») - * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) + * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) * * @package YooKassa */ @@ -53,32 +53,32 @@ class Transfer extends AbstractObject implements TransferInterface const MAX_LENGTH_DESCRIPTION = 128; /** - * @var string + * @var string Идентификатор магазина, в пользу которого вы принимаете оплату. Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). */ private $_accountId; /** - * @var AmountInterface + * @var AmountInterface Сумма, которую необходимо перечислить магазину. */ private $_amount; /** - * @var AmountInterface + * @var AmountInterface Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу. */ private $_platform_fee_amount; /** - * @var string + * @var string Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled. */ private $_status; /** - * @var string + * @var string Описание транзакции (не более 128 символов), которое продавец увидит в личном кабинете ЮKassa. Например: «Заказ маркетплейса №72». */ private $_description; /** - * @var string + * @var string Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). */ private $_metadata; @@ -89,11 +89,15 @@ class Transfer extends AbstractObject implements TransferInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "accountId" parameter in Transfer', 0, 'transfer.accountId' + 'Empty value for "accountId" parameter in Transfer', + 0, + 'transfer.accountId' ); } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "accountId" parameter in Transfer', 0, 'transfer.accountId' + 'Invalid value type for "accountId" parameter in Transfer', + 0, + 'transfer.accountId' ); } else { $this->_accountId = (string)$value; @@ -131,7 +135,9 @@ class Transfer extends AbstractObject implements TransferInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "amount" parameter in Transfer', 0, 'transfer.amount' + 'Empty value for "amount" parameter in Transfer', + 0, + 'transfer.amount' ); } elseif (is_array($value)) { $this->_amount = $this->factoryAmount($value); @@ -139,7 +145,10 @@ class Transfer extends AbstractObject implements TransferInterface $this->_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "amount" parameter in Transfer', 0, 'transfer.amount', $value + 'Invalid value type for "amount" parameter in Transfer', + 0, + 'transfer.amount', + $value ); } } @@ -167,7 +176,9 @@ class Transfer extends AbstractObject implements TransferInterface { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty value for "platform_fee_amount" parameter in Transfer', 0, 'transfer.platform_fee_amount' + 'Empty value for "platform_fee_amount" parameter in Transfer', + 0, + 'transfer.platform_fee_amount' ); } elseif (is_array($value)) { $this->_platform_fee_amount = $this->factoryAmount($value); @@ -175,7 +186,10 @@ class Transfer extends AbstractObject implements TransferInterface $this->_platform_fee_amount = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "platform_fee_amount" parameter in Transfer', 0, 'transfer.platform_fee_amount', $value + 'Invalid value type for "platform_fee_amount" parameter in Transfer', + 0, + 'transfer.platform_fee_amount', + $value ); } } @@ -187,11 +201,17 @@ class Transfer extends AbstractObject implements TransferInterface { if (!TypeCast::canCastToEnumString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid "status" value type', 0, 'transfer.status', $value + 'Invalid "status" value type', + 0, + 'transfer.status', + $value ); } elseif (!TransferStatus::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid "status" value', 0, 'transfer.status', $value + 'Invalid "status" value', + 0, + 'transfer.status', + $value ); } else { $this->_status = (string)$value; @@ -226,7 +246,10 @@ class Transfer extends AbstractObject implements TransferInterface if (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'Transfer.description', $value + 'Invalid description value type', + 0, + 'Transfer.description', + $value ); } @@ -263,7 +286,10 @@ class Transfer extends AbstractObject implements TransferInterface $this->_metadata = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "metadata" parameter in Transfer', 0, 'transfer.metadata', $value + 'Invalid value type for "metadata" parameter in Transfer', + 0, + 'transfer.metadata', + $value ); } } diff --git a/lib/Model/TransferInterface.php b/lib/Model/TransferInterface.php index 13b13e4f..1f7b144a 100644 --- a/lib/Model/TransferInterface.php +++ b/lib/Model/TransferInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -37,7 +37,7 @@ namespace YooKassa\Model; * @property string $accountId Идентификатор магазина, в пользу которого вы принимаете оплату * @property string $status Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` * @property string $description Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») - * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) + * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) * * @package YooKassa */ diff --git a/lib/Model/TransferStatus.php b/lib/Model/TransferStatus.php index a6652705..9561a109 100644 --- a/lib/Model/TransferStatus.php +++ b/lib/Model/TransferStatus.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,24 +26,26 @@ namespace YooKassa\Model; - use YooKassa\Common\AbstractEnum; /** * PaymentStatus - Статус операции распределения средств конечному получателю - * |Код|Описание| - * --- | --- - * |pending|Ожидает оплаты покупателем| - * |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| - * |succeeded|Успешно оплачен и получен магазином| - * |canceled|Неуспех оплаты или отменен магазином (cancel)| * + * Возможные значения: + * - `pending` - Ожидает оплаты покупателем + * - `waiting_for_capture` - Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) + * - `succeeded` - Успешно оплачен и получен магазином + * - `canceled` - Неуспех оплаты или отменен магазином (cancel) */ class TransferStatus extends AbstractEnum { + /** Ожидает оплаты покупателем */ const PENDING = 'pending'; + /** Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso) */ const WAITING_FOR_CAPTURE = 'waiting_for_capture'; + /** Успешно оплачен и получен магазином */ const SUCCEEDED = 'succeeded'; + /** Неуспех оплаты или отменен магазином (cancel) */ const CANCELED = 'canceled'; protected static $validValues = array( diff --git a/lib/Model/Webhook/Webhook.php b/lib/Model/Webhook/Webhook.php index 43d8b457..ea65ed97 100644 --- a/lib/Model/Webhook/Webhook.php +++ b/lib/Model/Webhook/Webhook.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Model\Webhook; - use YooKassa\Common\AbstractObject; use YooKassa\Model\NotificationEventType; diff --git a/lib/Request/Deals/AbstractDealResponse.php b/lib/Request/Deals/AbstractDealResponse.php index c0823661..b8e20060 100644 --- a/lib/Request/Deals/AbstractDealResponse.php +++ b/lib/Request/Deals/AbstractDealResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -35,4 +35,5 @@ use YooKassa\Model\SafeDeal; * @package YooKassa */ abstract class AbstractDealResponse extends SafeDeal implements DealInterface -{} +{ +} diff --git a/lib/Request/Deals/CreateDealRequest.php b/lib/Request/Deals/CreateDealRequest.php index e036e354..342d14b0 100644 --- a/lib/Request/Deals/CreateDealRequest.php +++ b/lib/Request/Deals/CreateDealRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -95,7 +95,10 @@ class CreateDealRequest extends AbstractRequest implements CreateDealRequestInte $this->_type = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal type value type', 0, 'CreateDealRequest.type', $value + 'Invalid deal type value type', + 0, + 'CreateDealRequest.type', + $value ); } } @@ -143,7 +146,10 @@ class CreateDealRequest extends AbstractRequest implements CreateDealRequestInte $this->_fee_moment = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid fee_moment value type in CreateDealRequest', 0, 'CreateDealRequest.fee_moment', $value + 'Invalid fee_moment value type in CreateDealRequest', + 0, + 'CreateDealRequest.fee_moment', + $value ); } } @@ -181,7 +187,10 @@ class CreateDealRequest extends AbstractRequest implements CreateDealRequestInte $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'CreateDealRequest.description', $value + 'Invalid description value type', + 0, + 'CreateDealRequest.description', + $value ); } } @@ -230,7 +239,10 @@ class CreateDealRequest extends AbstractRequest implements CreateDealRequestInte $this->_metadata = new Metadata($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid metadata value type in CreateDealRequest', 0, 'CreateDealRequest.metadata', $value + 'Invalid metadata value type in CreateDealRequest', + 0, + 'CreateDealRequest.metadata', + $value ); } } diff --git a/lib/Request/Deals/CreateDealRequestBuilder.php b/lib/Request/Deals/CreateDealRequestBuilder.php index 122f2d76..c32f7613 100644 --- a/lib/Request/Deals/CreateDealRequestBuilder.php +++ b/lib/Request/Deals/CreateDealRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Deals/CreateDealRequestInterface.php b/lib/Request/Deals/CreateDealRequestInterface.php index ebb49ed0..23afd674 100644 --- a/lib/Request/Deals/CreateDealRequestInterface.php +++ b/lib/Request/Deals/CreateDealRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -52,13 +52,13 @@ interface CreateDealRequestInterface * Проверяет наличие типа в создаваемой сделке * @return bool True если тип сделки установлен, false если нет */ - function hasType(); + public function hasType(); /** * Устанавливает тип сделки * @param string $value Тип сделки */ - function setType($value); + public function setType($value); /** * Возвращает момент перечисления вам вознаграждения платформы @@ -71,13 +71,13 @@ interface CreateDealRequestInterface * Проверяет наличие момента перечисления вознаграждения в создаваемой сделке * @return bool True если момент перечисления вознаграждения установлен, false если нет */ - function hasFeeMoment(); + public function hasFeeMoment(); /** * Устанавливает момент перечисления вознаграждения платформы * @param string $value Момент перечисления вознаграждения */ - function setFeeMoment($value); + public function setFeeMoment($value); /** * Возвращает описание сделки (не более 128 символов). @@ -90,13 +90,13 @@ interface CreateDealRequestInterface * Проверяет наличие описания в создаваемой сделке * @return bool True если описание сделки установлено, false если нет */ - function hasDescription(); + public function hasDescription(); /** * Устанавливает описание сделки * @param string $value Описание сделки */ - function setDescription($value); + public function setDescription($value); /** * Возвращает дополнительные данные сделки @@ -109,11 +109,11 @@ interface CreateDealRequestInterface * Проверяет, были ли установлены метаданные сделки * @return bool True если метаданные были установлены, false если нет */ - function hasMetadata(); + public function hasMetadata(); /** * Устанавливает метаданные, привязанные к сделке * @param Metadata|array|null $value Метаданные сделки, устанавливаемые мерчантом */ - function setMetadata($value); + public function setMetadata($value); } diff --git a/lib/Request/Deals/CreateDealRequestSerializer.php b/lib/Request/Deals/CreateDealRequestSerializer.php index 35539d33..17a6375c 100644 --- a/lib/Request/Deals/CreateDealRequestSerializer.php +++ b/lib/Request/Deals/CreateDealRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -38,7 +38,7 @@ class CreateDealRequestSerializer /** * Формирует ассоциативный массив данных из объекта запроса * - * @param CreateDealRequestInterface|AbstractRequest $request Объект запроса + * @param CreateDealRequestInterface $request Объект запроса * @return array Массив данных для дальнейшего кодирования в JSON */ public function serialize(CreateDealRequestInterface $request) @@ -60,5 +60,4 @@ class CreateDealRequestSerializer return $result; } - } diff --git a/lib/Request/Deals/CreateDealResponse.php b/lib/Request/Deals/CreateDealResponse.php index d18b55ba..7cbfc3a1 100644 --- a/lib/Request/Deals/CreateDealResponse.php +++ b/lib/Request/Deals/CreateDealResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Deals; * @package YooKassa */ class CreateDealResponse extends AbstractDealResponse -{} +{ +} diff --git a/lib/Request/Deals/DealResponse.php b/lib/Request/Deals/DealResponse.php index 638ecb2d..3dcc5d30 100644 --- a/lib/Request/Deals/DealResponse.php +++ b/lib/Request/Deals/DealResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Deals; * @package YooKassa */ class DealResponse extends AbstractDealResponse -{} +{ +} diff --git a/lib/Request/Deals/DealsRequest.php b/lib/Request/Deals/DealsRequest.php index 5a5dfe0f..5114d86d 100644 --- a/lib/Request/Deals/DealsRequest.php +++ b/lib/Request/Deals/DealsRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -148,13 +148,19 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface } elseif (is_int($value)) { if ($value < 0 || $value > self::MAX_LIMIT_VALUE) { throw new InvalidPropertyValueException( - 'Invalid limit value in DealsRequest', 0, 'DealsRequest.limit', $value + 'Invalid limit value in DealsRequest', + 0, + 'DealsRequest.limit', + $value ); } $this->_limit = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid limit value type in DealsRequest', 0, 'DealsRequest.limit', $value + 'Invalid limit value type in DealsRequest', + 0, + 'DealsRequest.limit', + $value ); } } @@ -191,7 +197,10 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $this->_cursor = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in DealsRequest', 0, 'DealsRequest.limit', $value + 'Invalid status value type in DealsRequest', + 0, + 'DealsRequest.limit', + $value ); } } @@ -231,13 +240,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtGte value in DealsRequest', 0, 'PaymentRequest.createdAtGte' + 'Invalid createdAtGte value in DealsRequest', + 0, + 'PaymentRequest.createdAtGte' ); } $this->_createdAtGte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtGte value type in DealsRequest', 0, 'PaymentRequest.createdAtGte' + 'Invalid createdAtGte value type in DealsRequest', + 0, + 'PaymentRequest.createdAtGte' ); } } @@ -277,13 +290,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtGt value in DealsRequest', 0, 'PaymentRequest.createdAtGt' + 'Invalid createdAtGt value in DealsRequest', + 0, + 'PaymentRequest.createdAtGt' ); } $this->_createdAtGt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtGt value type in DealsRequest', 0, 'PaymentRequest.createdAtGt' + 'Invalid createdAtGt value type in DealsRequest', + 0, + 'PaymentRequest.createdAtGt' ); } } @@ -323,13 +340,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtLte value in DealsRequest', 0, 'PaymentRequest.createdAtLte' + 'Invalid createdAtLte value in DealsRequest', + 0, + 'PaymentRequest.createdAtLte' ); } $this->_createdAtLte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtLte value type in DealsRequest', 0, 'PaymentRequest.createdAtLte' + 'Invalid createdAtLte value type in DealsRequest', + 0, + 'PaymentRequest.createdAtLte' ); } } @@ -369,13 +390,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtLt value in DealsRequest', 0, 'PaymentRequest.createdAtLt' + 'Invalid createdAtLt value in DealsRequest', + 0, + 'PaymentRequest.createdAtLt' ); } $this->_createdAtLt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAlLt value type in DealsRequest', 0, 'PaymentRequest.createdAtLt' + 'Invalid createdAlLt value type in DealsRequest', + 0, + 'PaymentRequest.createdAtLt' ); } } @@ -415,13 +440,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid expiresAtGte value in DealsRequest', 0, 'PaymentRequest.expiresAtGte' + 'Invalid expiresAtGte value in DealsRequest', + 0, + 'PaymentRequest.expiresAtGte' ); } $this->_expiresAtGte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid expiresAtGte value type in DealsRequest', 0, 'PaymentRequest.expiresAtGte' + 'Invalid expiresAtGte value type in DealsRequest', + 0, + 'PaymentRequest.expiresAtGte' ); } } @@ -461,13 +490,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid expiresAtGt value in DealsRequest', 0, 'PaymentRequest.expiresAtGt' + 'Invalid expiresAtGt value in DealsRequest', + 0, + 'PaymentRequest.expiresAtGt' ); } $this->_expiresAtGt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid expiresAtGt value type in DealsRequest', 0, 'PaymentRequest.expiresAtGt' + 'Invalid expiresAtGt value type in DealsRequest', + 0, + 'PaymentRequest.expiresAtGt' ); } } @@ -507,13 +540,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid expiresAtLte value in DealsRequest', 0, 'PaymentRequest.expiresAtLte' + 'Invalid expiresAtLte value in DealsRequest', + 0, + 'PaymentRequest.expiresAtLte' ); } $this->_expiresAtLte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid expiresAtLte value type in DealsRequest', 0, 'PaymentRequest.expiresAtLte' + 'Invalid expiresAtLte value type in DealsRequest', + 0, + 'PaymentRequest.expiresAtLte' ); } } @@ -553,13 +590,17 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid expiresAtLt value in DealsRequest', 0, 'PaymentRequest.expiresAtLt' + 'Invalid expiresAtLt value in DealsRequest', + 0, + 'PaymentRequest.expiresAtLt' ); } $this->_expiresAtLt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid expiresAlLt value type in DealsRequest', 0, 'PaymentRequest.expiresAtLt' + 'Invalid expiresAlLt value type in DealsRequest', + 0, + 'PaymentRequest.expiresAtLt' ); } } @@ -596,14 +637,20 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface } elseif (TypeCast::canCastToEnumString($value)) { if (!DealStatus::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid status value in DealsRequest', 0, 'DealsRequest.status', $value + 'Invalid status value in DealsRequest', + 0, + 'DealsRequest.status', + $value ); } else { $this->_status = (string)$value; } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value in DealsRequest', 0, 'DealsRequest.status', $value + 'Invalid status value in DealsRequest', + 0, + 'DealsRequest.status', + $value ); } } @@ -658,7 +705,10 @@ class DealsRequest extends AbstractRequest implements DealsRequestInterface $this->_fullTextSearch = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in DealsRequest', 0, 'DealsRequest.fullTextSearch', $value + 'Invalid status value type in DealsRequest', + 0, + 'DealsRequest.fullTextSearch', + $value ); } } diff --git a/lib/Request/Deals/DealsRequestBuilder.php b/lib/Request/Deals/DealsRequestBuilder.php index 66c2457d..07048efd 100644 --- a/lib/Request/Deals/DealsRequestBuilder.php +++ b/lib/Request/Deals/DealsRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Deals/DealsRequestInterface.php b/lib/Request/Deals/DealsRequestInterface.php index 1d8dd1e7..5d0209d8 100644 --- a/lib/Request/Deals/DealsRequestInterface.php +++ b/lib/Request/Deals/DealsRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -50,227 +50,227 @@ interface DealsRequestInterface * Возвращает страницу выдачи результатов или null, если она до этого не была установлена * @return string|null Страница выдачи результатов */ - function getCursor(); + public function getCursor(); /** * Проверяет, была ли установлена страница выдачи результатов * @return bool True если страница выдачи результатов была установлена, false если нет */ - function hasCursor(); + public function hasCursor(); /** * Устанавливает страницу выдачи результатов * @param string $value Страница * @return void */ - function setCursor($value); + public function setCursor($value); /** * Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время создания, от (включительно) */ - function getCreatedAtGte(); + public function getCreatedAtGte(); /** * Проверяет, была ли установлена дата создания от которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGte(); + public function hasCreatedAtGte(); /** * Устанавливает дату создания от которой выбираются сделки * @param \DateTime $value Дата * @return void */ - function setCreatedAtGte($value); + public function setCreatedAtGte($value); /** * Возвращает дату создания от которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время создания, от (не включая) */ - function getCreatedAtGt(); + public function getCreatedAtGt(); /** * Проверяет, была ли установлена дата создания от которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGt(); + public function hasCreatedAtGt(); /** * Устанавливает дату создания от которой выбираются сделки * @param \DateTime $value Дата * @return void */ - function setCreatedAtGt($value); + public function setCreatedAtGt($value); /** * Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время создания, до (включительно) */ - function getCreatedAtLte(); + public function getCreatedAtLte(); /** * Проверяет, была ли установлена дата создания до которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLte(); + public function hasCreatedAtLte(); /** * Устанавливает дату создания до которой выбираются сделки * @param \DateTime $value Дата * @return void */ - function setCreatedAtLte($value); + public function setCreatedAtLte($value); /** * Возвращает дату создания до которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время создания, до (не включая) */ - function getCreatedAtLt(); + public function getCreatedAtLt(); /** * Проверяет, была ли установлена дата создания до которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLt(); + public function hasCreatedAtLt(); /** * Устанавливает дату создания до которой выбираются сделки * @param \DateTime $value Дата * @return void */ - function setCreatedAtLt($value); + public function setCreatedAtLt($value); /** * Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время автоматического закрытия, от (включительно) */ - function getExpiresAtGte(); + public function getExpiresAtGte(); /** * Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasExpiresAtGte(); + public function hasExpiresAtGte(); /** * Устанавливает дату автоматического закрытия от которой выбираются сделки * @param \DateTime $value Дата * @return void */ - function setExpiresAtGte($value); + public function setExpiresAtGte($value); /** * Возвращает дату автоматического закрытия от которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время автоматического закрытия, от (не включая) */ - function getExpiresAtGt(); + public function getExpiresAtGt(); /** * Проверяет, была ли установлена дата автоматического закрытия от которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasExpiresAtGt(); + public function hasExpiresAtGt(); /** * Устанавливает дату автоматического закрытия от которой выбираются сделки * @param \DateTime $value Дата автоматического закрытия * @return void */ - function setExpiresAtGt($value); + public function setExpiresAtGt($value); /** * Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время автоматического закрытия, до (включительно) */ - function getExpiresAtLte(); + public function getExpiresAtLte(); /** * Проверяет, была ли установлена дата автоматического закрытия до которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasExpiresAtLte(); + public function hasExpiresAtLte(); /** * Устанавливает дату автоматического закрытия до которой выбираются сделки * @param \DateTime $value Дата автоматического закрытия * @return void */ - function setExpiresAtLte($value); + public function setExpiresAtLte($value); /** * Возвращает дату автоматического закрытия до которой будут возвращены сделки или null, если дата не была установлена * @return \DateTime|null Время автоматического закрытия, до (не включая) */ - function getExpiresAtLt(); + public function getExpiresAtLt(); /** * Проверяет, была ли установлена автоматического закрытия до которой выбираются сделки * @return bool True если дата была установлена, false если нет */ - function hasExpiresAtLt(); + public function hasExpiresAtLt(); /** * Устанавливает дату автоматического закрытия до которой выбираются сделки * @param \DateTime $value Дата автоматического закрытия * @return void */ - function setExpiresAtLt($value); + public function setExpiresAtLt($value); /** * Возвращает ограничение количества объектов сделок или null, если оно до этого не было установлено * @return string|null Ограничение количества объектов сделок */ - function getLimit(); + public function getLimit(); /** * Проверяет, было ли установлено ограничение количества объектов сделок * @return bool True если ограничение количества объектов сделок было установлено, false если нет */ - function hasLimit(); + public function hasLimit(); /** * Устанавливает ограничение количества объектов сделок * @param int $value Количества объектов сделок на странице * @return void */ - function setLimit($value); + public function setLimit($value); /** * Возвращает статус выбираемых сделок или null, если он до этого не был установлен * @return string|null Статус выбираемых сделок */ - function getStatus(); + public function getStatus(); /** * Проверяет, был ли установлен статус выбираемых сделок * @return bool True если статус был установлен, false если нет */ - function hasStatus(); + public function hasStatus(); /** * Устанавливает статус выбираемых сделок * @param string $value Статус сделок * @return void */ - function setStatus($value); + public function setStatus($value); /** * Возвращает фильтр по описанию сделки или null, если он до этого не был установлен * @return string|null Фильтр по описанию сделки */ - function getFullTextSearch(); + public function getFullTextSearch(); /** * Проверяет, был ли установлен фильтр по описанию сделки * @return bool True если фильтр по описанию сделки был установлен, false если нет */ - function hasFullTextSearch(); + public function hasFullTextSearch(); /** * Устанавливает фильтр по описанию сделки * @param string $value Фильтр по описанию сделки * @return void */ - function setFullTextSearch($value); + public function setFullTextSearch($value); } diff --git a/lib/Request/Deals/DealsRequestSerializer.php b/lib/Request/Deals/DealsRequestSerializer.php index 51a3137d..21ad035e 100644 --- a/lib/Request/Deals/DealsRequestSerializer.php +++ b/lib/Request/Deals/DealsRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Deals/DealsResponse.php b/lib/Request/Deals/DealsResponse.php index eb31c462..a0ef7134 100644 --- a/lib/Request/Deals/DealsResponse.php +++ b/lib/Request/Deals/DealsResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -90,5 +90,4 @@ class DealsResponse extends AbstractObject { return $this->nextCursor !== null; } - } diff --git a/lib/Request/Payments/AbstractPaymentResponse.php b/lib/Request/Payments/AbstractPaymentResponse.php index e5a11fc4..328aaf94 100644 --- a/lib/Request/Payments/AbstractPaymentResponse.php +++ b/lib/Request/Payments/AbstractPaymentResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -146,13 +146,12 @@ abstract class AbstractPaymentResponse extends Payment implements PaymentInterfa $confirmation->setReturnUrl($sourceArray['confirmation']['return_url']); } break; - } if (isset($confirmation)) { $this->setConfirmation($confirmation); } else { - throw new InvalidArgumentException('confirmation type '.$confirmationType.' is incorrect'); + throw new InvalidArgumentException('confirmation type ' . $confirmationType . ' is incorrect'); } } if (!empty($sourceArray['refunded_amount'])) { diff --git a/lib/Request/Payments/CreatePaymentRequest.php b/lib/Request/Payments/CreatePaymentRequest.php index 73966da6..fd8003d4 100644 --- a/lib/Request/Payments/CreatePaymentRequest.php +++ b/lib/Request/Payments/CreatePaymentRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -34,6 +34,7 @@ use YooKassa\Model\AirlineInterface; use YooKassa\Model\AmountInterface; use YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory; use YooKassa\Model\Deal\PaymentDealInfo; +use YooKassa\Model\FraudData; use YooKassa\Model\Payment; use YooKassa\Model\PaymentData\AbstractPaymentData; use YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes; @@ -66,6 +67,8 @@ use YooKassa\Model\RecipientInterface; * @property string $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения * @property Metadata $metadata Метаданные привязанные к платежу * @property PaymentDealInfo $deal Данные о сделке, в составе которой проходит платеж + * @property FraudData $fraudData Информация для проверки операции на мошенничество + * @property FraudData $fraud_data Информация для проверки операции на мошенничество * @property string $merchantCustomerId Идентификатор покупателя в вашей системе, например электронная почта или номер телефона * @property string $merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона */ @@ -133,6 +136,11 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme */ private $_deal; + /** + * @var FraudData Информация для проверки операции на мошенничество + */ + private $_fraud_data; + /** * @var string Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов. * Присутствует, если вы хотите запомнить банковскую карту и отобразить ее при повторном платеже в виджете ЮKassa @@ -190,7 +198,10 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'CreatePaymentRequest.description', $value + 'Invalid description value type', + 0, + 'CreatePaymentRequest.description', + $value ); } } @@ -252,13 +263,19 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $length = mb_strlen((string)$value, 'utf-8'); if ($length > self::MAX_LENGTH_PAYMENT_TOKEN) { throw new InvalidPropertyValueException( - 'Invalid paymentToken value', 0, 'CreatePaymentRequest.paymentToken', $value + 'Invalid paymentToken value', + 0, + 'CreatePaymentRequest.paymentToken', + $value ); } $this->_paymentToken = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid paymentToken value type', 0, 'CreatePaymentRequest.paymentToken', $value + 'Invalid paymentToken value type', + 0, + 'CreatePaymentRequest.paymentToken', + $value ); } } @@ -459,7 +476,10 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_capture = (bool)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid capture value type in CreatePaymentRequest', 0, 'CreatePaymentRequest.capture', $value + 'Invalid capture value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.capture', + $value ); } } @@ -496,7 +516,10 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_clientIp = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid clientIp value type in CreatePaymentRequest', 0, 'CreatePaymentRequest.clientIp', $value + 'Invalid clientIp value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.clientIp', + $value ); } } @@ -514,7 +537,7 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme * Проверяет, были ли установлены данные авиабилетов * @return bool */ - function hasAirline() + public function hasAirline() { return $this->_airline !== null; } @@ -563,7 +586,10 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_metadata = new Metadata($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid metadata value type in CreatePaymentRequest', 0, 'CreatePaymentRequest.metadata', $value + 'Invalid metadata value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.metadata', + $value ); } } @@ -602,11 +628,56 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_deal = new PaymentDealInfo($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal value type in CreatePaymentRequest', 0, 'CreatePaymentRequest.deal', $value + 'Invalid deal value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.deal', + $value ); } } + /** + * Возвращает информацию для проверки операции на мошенничество. + * + * @return FraudData|null Информация для проверки операции на мошенничество + */ + public function getFraudData() + { + return $this->_fraud_data; + } + + /** + * Устанавливает информацию для проверки операции на мошенничество. + * + * @param FraudData|array|null $value Информация для проверки операции на мошенничество + */ + public function setFraudData($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_fraud_data = null; + } elseif ($value instanceof FraudData) { + $this->_fraud_data = $value; + } elseif (is_array($value)) { + $this->_fraud_data = new FraudData($value); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid fraud_data value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.fraud_data', + $value + ); + } + } + + /** + * Проверяет, была ли установлена информация для проверки операции на мошенничество + * @return bool True если информация была установлена, false если нет + */ + public function hasFraudData() + { + return !empty($this->_fraud_data); + } + /** * Возвращает идентификатор покупателя в вашей системе * @return string Идентификатор покупателя в вашей системе @@ -648,7 +719,10 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme $this->_merchant_customer_id = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid merchant_customer_id value type in CreatePaymentRequest', 0, 'CreatePaymentRequest.merchant_customer_id', $value + 'Invalid merchant_customer_id value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.merchant_customer_id', + $value ); } } diff --git a/lib/Request/Payments/CreatePaymentRequestBuilder.php b/lib/Request/Payments/CreatePaymentRequestBuilder.php index f480687a..8d7f96cb 100644 --- a/lib/Request/Payments/CreatePaymentRequestBuilder.php +++ b/lib/Request/Payments/CreatePaymentRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -39,6 +39,7 @@ use YooKassa\Model\AirlineInterface; use YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes; use YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory; use YooKassa\Model\Deal\PaymentDealInfo; +use YooKassa\Model\FraudData; use YooKassa\Model\Metadata; use YooKassa\Model\Payment; use YooKassa\Model\PaymentData\AbstractPaymentData; @@ -89,6 +90,12 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder */ protected $deal; + /** + * Объект с информацией о сделке, в составе которой проходит платеж. + * @var FraudData + */ + protected $fraud_data; + /** * Инициализирует объект запроса, который в дальнейшем будет собираться билдером * @return CreatePaymentRequest Инстанс собираемого объекта запроса к API @@ -341,6 +348,34 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder return $this; } + /** + * Устанавливает сделку + * @param FraudData|array|null $value Данные о сделке, в составе которой проходит платеж + * @throws InvalidPropertyValueTypeException + * + * @return CreatePaymentRequestBuilder Информация для проверки операции на мошенничество + */ + public function setFraudData($value) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->fraud_data = null; + return $this; + } + if ($value instanceof FraudData) { + $this->fraud_data = $value; + } elseif (is_array($value)) { + $this->fraud_data = new FraudData($value); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid fraud_data value type in CreatePaymentRequest', + 0, + 'CreatePaymentRequest.fraud_data', + $value + ); + } + return $this; + } + /** * Устанавливает идентификатор покупателя в вашей системе * @param string $value Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов @@ -411,7 +446,7 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder if ($this->receipt->notEmpty()) { $this->currentObject->setReceipt($this->receipt); } - if($this->airline->notEmpty()){ + if ($this->airline->notEmpty()) { $this->currentObject->setAirline($this->airline); } $this->currentObject->setAmount($this->amount); @@ -419,6 +454,9 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder if ($this->deal) { $this->currentObject->setDeal($this->deal); } + if ($this->fraud_data) { + $this->currentObject->setFraudData($this->fraud_data); + } return parent::build(); } diff --git a/lib/Request/Payments/CreatePaymentRequestInterface.php b/lib/Request/Payments/CreatePaymentRequestInterface.php index 6cb93ab6..ad69ff15 100644 --- a/lib/Request/Payments/CreatePaymentRequestInterface.php +++ b/lib/Request/Payments/CreatePaymentRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -31,6 +31,7 @@ use YooKassa\Model\AirlineInterface; use YooKassa\Model\AmountInterface; use YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes; use YooKassa\Model\Deal\PaymentDealInfo; +use YooKassa\Model\FraudData; use YooKassa\Model\Metadata; use YooKassa\Model\PaymentData\AbstractPaymentData; use YooKassa\Model\ReceiptInterface; @@ -60,6 +61,8 @@ use YooKassa\Model\TransferInterface; * @property-read Metadata $metadata Метаданные привязанные к платежу * @property-read TransferInterface[] $transfers Метаданные привязанные к платежу * @property-read PaymentDealInfo $deal Данные о сделке, в составе которой проходит платеж + * @property-read FraudData $fraudData Информация для проверки операции на мошенничество + * @property-read FraudData $fraud_data Информация для проверки операции на мошенничество * @property-read string $merchantCustomerId Идентификатор покупателя в вашей системе, например электронная почта или номер телефона * @property-read string $merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона */ @@ -69,223 +72,223 @@ interface CreatePaymentRequestInterface * Возвращает объект получателя платежа * @return RecipientInterface|null Объект с информацией о получателе платежа или null, если получатель не задан */ - function getRecipient(); + public function getRecipient(); /** * Проверяет наличие получателя платежа в запросе * @return bool True если получатель платежа задан, false если нет */ - function hasRecipient(); + public function hasRecipient(); /** * Устанавливает объект с информацией о получателе платежа * @param RecipientInterface|null $value Инстанс объекта информации о получателе платежа или null */ - function setRecipient($value); + public function setRecipient($value); /** * Возвращает сумму заказа * @return AmountInterface Сумма заказа */ - function getAmount(); + public function getAmount(); /** * Возвращает описание транзакции * @return string Описание транзакции */ - function getDescription(); + public function getDescription(); /** * Проверяет наличие описания транзакции в создаваемом платеже * @return bool True если описание транзакции установлено, false если нет */ - function hasDescription(); + public function hasDescription(); /** * Устанавливает описание транзакции * @param string $value Описание транзакции */ - function setDescription($value); + public function setDescription($value); /** * Возвращает чек, если он есть * @return ReceiptInterface|null Данные фискального чека 54-ФЗ или null, если чека нет */ - function getReceipt(); + public function getReceipt(); /** * Проверяет наличие чека в создаваемом платеже * @return bool True если чек есть, false если нет */ - function hasReceipt(); + public function hasReceipt(); /** * Возвращает одноразовый токен для проведения оплаты * @return string Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget */ - function getPaymentToken(); + public function getPaymentToken(); /** * Проверяет наличие одноразового токена для проведения оплаты * @return bool True если токен установлен, false если нет */ - function hasPaymentToken(); + public function hasPaymentToken(); /** * Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget * @param string $value Одноразовый токен для проведения оплаты */ - function setPaymentToken($value); + public function setPaymentToken($value); /** * Устанавливает идентификатор записи платёжных данных покупателя * @return string Идентификатор записи о сохраненных платежных данных покупателя */ - function getPaymentMethodId(); + public function getPaymentMethodId(); /** * Проверяет наличие идентификатора записи о платёжных данных покупателя * @return bool True если идентификатор задан, false если нет */ - function hasPaymentMethodId(); + public function hasPaymentMethodId(); /** * Устанавливает идентификатор записи о сохранённых данных покупателя * @param string $value Идентификатор записи о сохраненных платежных данных покупателя */ - function setPaymentMethodId($value); + public function setPaymentMethodId($value); /** * Возвращает данные для создания метода оплаты * @return AbstractPaymentData Данные используемые для создания метода оплаты */ - function getPaymentMethodData(); + public function getPaymentMethodData(); /** * Проверяет установлен ли объект с методом оплаты * @return bool True если объект метода оплаты установлен, false если нет */ - function hasPaymentMethodData(); + public function hasPaymentMethodData(); /** * Устанавливает объект с информацией для создания метода оплаты * @param AbstractPaymentData|null $value Объект создания метода оплаты или null */ - function setPaymentMethodData($value); + public function setPaymentMethodData($value); /** * Возвращает способ подтверждения платежа * @return AbstractConfirmationAttributes Способ подтверждения платежа */ - function getConfirmation(); + public function getConfirmation(); /** * Проверяет, был ли установлен способ подтверждения платежа * @return bool True если способ подтверждения платежа был установлен, false если нет */ - function hasConfirmation(); + public function hasConfirmation(); /** * Устанавливает способ подтверждения платежа * @param AbstractConfirmationAttributes|null $value Способ подтверждения платежа */ - function setConfirmation($value); + public function setConfirmation($value); /** * Возвращает флаг сохранения платёжных данных * @return bool Флаг сохранения платёжных данных */ - function getSavePaymentMethod(); + public function getSavePaymentMethod(); /** * Проверяет, был ли установлен флаг сохранения платёжных данных * @return bool True если флыг был установлен, false если нет */ - function hasSavePaymentMethod(); + public function hasSavePaymentMethod(); /** * Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. * @param bool $value Сохранить платежные данные для последующего использования */ - function setSavePaymentMethod($value); + public function setSavePaymentMethod($value); /** * Возвращает флаг автоматического принятия поступившей оплаты * @return bool True если требуется автоматически принять поступившую оплату, false если нет */ - function getCapture(); + public function getCapture(); /** * Проверяет, был ли установлен флаг автоматического приняти поступившей оплаты * @return bool True если флаг автоматического принятия оплаты был установлен, false если нет */ - function hasCapture(); + public function hasCapture(); /** * Устанавливает флаг автоматического принятия поступившей оплаты * @param bool $value Автоматически принять поступившую оплату */ - function setCapture($value); + public function setCapture($value); /** * Возвращает IPv4 или IPv6-адрес покупателя * @return string IPv4 или IPv6-адрес покупателя */ - function getClientIp(); + public function getClientIp(); /** * Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя * @return bool True если IP адрес покупателя был установлен, false если нет */ - function hasClientIp(); + public function hasClientIp(); /** * Устанавливает IP адрес покупателя * @param string $value IPv4 или IPv6-адрес покупателя */ - function setClientIp($value); + public function setClientIp($value); /** * Возвращает данные оплаты установленные мерчантом * @return Metadata Метаданные привязанные к платежу */ - function getMetadata(); + public function getMetadata(); /** * Проверяет, были ли установлены метаданные заказа * @return bool True если метаданные были установлены, false если нет */ - function hasMetadata(); + public function hasMetadata(); /** * Устанавливает метаданные, привязанные к платежу * @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом */ - function setMetadata($value); + public function setMetadata($value); /** * Возвращает данные длинной записи * @return Airline */ - function getAirline(); + public function getAirline(); /** * Проверяет, были ли установлены данные длинной записи * @return bool */ - function hasAirline(); + public function hasAirline(); /** * Устанавливает данные авиабилетов * @param AirlineInterface $value Данные авиабилетов */ - function setAirline($value); + public function setAirline($value); /** * Проверяет наличие данных о распределении денег * @return bool */ - function hasTransfers(); + public function hasTransfers(); /** * Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. @@ -294,50 +297,68 @@ interface CreatePaymentRequestInterface * * @return TransferInterface[] Данные о распределении денег */ - function getTransfers(); + public function getTransfers(); /** * Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести. * Присутствует, если вы используете решение ЮKassa для платформ. * (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) * - * @param TransferInterface[]|array|null Данные о распределении денег + * @param TransferInterface[]|array|null $value Данные о распределении денег */ - function setTransfers($value); + public function setTransfers($value); /** * Возвращает данные о сделке, в составе которой проходит платеж * @return PaymentDealInfo Данные о сделке, в составе которой проходит платеж. */ - function getDeal(); + public function getDeal(); /** * Проверяет, были ли установлены данные о сделке * @return bool True если данные о сделке были установлены, false если нет */ - function hasDeal(); + public function hasDeal(); /** * Устанавливает данные о сделке, в составе которой проходит платеж. * @param PaymentDealInfo|array|null $value Данные о сделке, в составе которой проходит платеж */ - function setDeal($value); + public function setDeal($value); + + /** + * Возвращает информацию для проверки операции на мошенничество + * @return FraudData Информация для проверки операции на мошенничество + */ + public function getFraudData(); + + /** + * Проверяет, была ли установлена информация для проверки операции на мошенничество + * @return bool True если информация была установлена, false если нет + */ + public function hasFraudData(); + + /** + * Устанавливает информацию для проверки операции на мошенничество + * @param FraudData|array|null $value Информация для проверки операции на мошенничество + */ + public function setFraudData($value); /** * Возвращает идентификатор покупателя в вашей системе * @return string Идентификатор покупателя в вашей системе */ - function getMerchantCustomerId(); + public function getMerchantCustomerId(); /** * Проверяет, был ли установлен идентификатор покупателя в вашей системе * @return bool True если идентификатор покупателя был установлен, false если нет */ - function hasMerchantCustomerId(); + public function hasMerchantCustomerId(); /** * Устанавливает идентификатор покупателя в вашей системе * @param string $value Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов */ - function setMerchantCustomerId($value); + public function setMerchantCustomerId($value); } diff --git a/lib/Request/Payments/CreatePaymentRequestSerializer.php b/lib/Request/Payments/CreatePaymentRequestSerializer.php index 75787833..627d7900 100644 --- a/lib/Request/Payments/CreatePaymentRequestSerializer.php +++ b/lib/Request/Payments/CreatePaymentRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -200,7 +200,7 @@ class CreatePaymentRequestSerializer } $customer = $receipt->getCustomer(); - if (!empty($customer)) { + if ($customer !== null) { $result['customer'] = $customer->jsonSerialize(); } diff --git a/lib/Request/Payments/CreatePaymentResponse.php b/lib/Request/Payments/CreatePaymentResponse.php index 3a42e5dd..34b7c8fd 100644 --- a/lib/Request/Payments/CreatePaymentResponse.php +++ b/lib/Request/Payments/CreatePaymentResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Payments; * @package YooKassa */ class CreatePaymentResponse extends AbstractPaymentResponse -{} +{ +} diff --git a/lib/Request/Payments/Payment/CancelResponse.php b/lib/Request/Payments/Payment/CancelResponse.php index 487649e8..653f0e41 100644 --- a/lib/Request/Payments/Payment/CancelResponse.php +++ b/lib/Request/Payments/Payment/CancelResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -34,4 +34,5 @@ use YooKassa\Request\Payments\AbstractPaymentResponse; * @package YooKassa */ class CancelResponse extends AbstractPaymentResponse -{} +{ +} diff --git a/lib/Request/Payments/Payment/CreateCaptureRequest.php b/lib/Request/Payments/Payment/CreateCaptureRequest.php index 797bad69..b5524e63 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequest.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -78,7 +78,10 @@ class CreateCaptureRequest extends AbstractPaymentRequest implements CreateCaptu $this->_deal = new CaptureDealData($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal value type in CreateCaptureRequest', 0, 'CreateCaptureRequest.deal', $value + 'Invalid deal value type in CreateCaptureRequest', + 0, + 'CreateCaptureRequest.deal', + $value ); } } diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php b/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php index 84f0e2d5..38694a75 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php b/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php index c14f9ff8..e70f1b8a 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,74 +47,74 @@ interface CreateCaptureRequestInterface * Возвращает подтверждаемую сумму оплаты * @return AmountInterface Подтверждаемая сумма оплаты */ - function getAmount(); + public function getAmount(); /** * Проверяет, была ли установлена сумма оплаты * @return bool True если сумма оплаты была установлена, false если нет */ - function hasAmount(); + public function hasAmount(); /** * Устанавливает сумму оплаты * @param AmountInterface $value Сумма оплаты */ - function setAmount(AmountInterface $value); + public function setAmount(AmountInterface $value); /** * Возвращает чек, если он есть * @return ReceiptInterface|null Данные фискального чека 54-ФЗ или null, если чека нет * @since 1.0.2 */ - function getReceipt(); + public function getReceipt(); /** * Проверяет наличие чека в создаваемом платеже * @return bool True если чек есть, false если нет * @since 1.0.2 */ - function hasReceipt(); + public function hasReceipt(); /** * Устанавливает чек * @param ReceiptInterface|null $value Инстанс чека или null для удаления информации о чеке * @throws InvalidPropertyValueTypeException Выбрасывается если передан не инстанс класса чека и не null */ - function setReceipt($value); + public function setReceipt($value); /** * Проверяет наличие данных о распределении денег * @return bool */ - function hasTransfers(); + public function hasTransfers(); /** * Возвращает данные о распределении денег * @return TransferInterface[] */ - function getTransfers(); + public function getTransfers(); /** * Устанавливает transfers (массив распределения денег между магазинами) * @param TransferInterface[]|array|null $value */ - function setTransfers($value); + public function setTransfers($value); /** * Проверяет наличие данных о сделке * @return bool */ - function hasDeal(); + public function hasDeal(); /** * Возвращает данные о сделке * @return PaymentDealInfo */ - function getDeal(); + public function getDeal(); /** * Устанавливает данные о сделке * @param PaymentDealInfo|array|null $value */ - function setDeal($value); + public function setDeal($value); } diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php b/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php index c329da58..d436fa5d 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Payments/Payment/CreateCaptureResponse.php b/lib/Request/Payments/Payment/CreateCaptureResponse.php index 371c2b8c..4d056853 100644 --- a/lib/Request/Payments/Payment/CreateCaptureResponse.php +++ b/lib/Request/Payments/Payment/CreateCaptureResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -34,4 +34,5 @@ use YooKassa\Request\Payments\AbstractPaymentResponse; * @package YooKassa */ class CreateCaptureResponse extends AbstractPaymentResponse -{} +{ +} diff --git a/lib/Request/Payments/PaymentResponse.php b/lib/Request/Payments/PaymentResponse.php index 782fadeb..7d158c03 100644 --- a/lib/Request/Payments/PaymentResponse.php +++ b/lib/Request/Payments/PaymentResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Payments; * @package YooKassa */ class PaymentResponse extends AbstractPaymentResponse -{} +{ +} diff --git a/lib/Request/Payments/PaymentsRequest.php b/lib/Request/Payments/PaymentsRequest.php index f9c4a037..43489331 100644 --- a/lib/Request/Payments/PaymentsRequest.php +++ b/lib/Request/Payments/PaymentsRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -150,13 +150,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtGte value in PaymentsRequest', 0, 'PaymentRequest.createdAtGte' + 'Invalid createdAtGte value in PaymentsRequest', + 0, + 'PaymentRequest.createdAtGte' ); } $this->_createdAtGte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtGte value type in PaymentsRequest', 0, 'PaymentRequest.createdAtGte' + 'Invalid createdAtGte value type in PaymentsRequest', + 0, + 'PaymentRequest.createdAtGte' ); } } @@ -196,13 +200,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtGt value in PaymentsRequest', 0, 'PaymentRequest.createdAtGt' + 'Invalid createdAtGt value in PaymentsRequest', + 0, + 'PaymentRequest.createdAtGt' ); } $this->_createdAtGt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtGt value type in PaymentsRequest', 0, 'PaymentRequest.createdAtGt' + 'Invalid createdAtGt value type in PaymentsRequest', + 0, + 'PaymentRequest.createdAtGt' ); } } @@ -242,13 +250,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtLte value in PaymentsRequest', 0, 'PaymentRequest.createdAtLte' + 'Invalid createdAtLte value in PaymentsRequest', + 0, + 'PaymentRequest.createdAtLte' ); } $this->_createdAtLte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAtLte value type in PaymentsRequest', 0, 'PaymentRequest.createdAtLte' + 'Invalid createdAtLte value type in PaymentsRequest', + 0, + 'PaymentRequest.createdAtLte' ); } } @@ -288,13 +300,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid createdAtLt value in PaymentsRequest', 0, 'PaymentRequest.createdAtLt' + 'Invalid createdAtLt value in PaymentsRequest', + 0, + 'PaymentRequest.createdAtLt' ); } $this->_createdAtLt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid createdAlLt value type in PaymentsRequest', 0, 'PaymentRequest.createdAtLt' + 'Invalid createdAlLt value type in PaymentsRequest', + 0, + 'PaymentRequest.createdAtLt' ); } } @@ -334,13 +350,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid capturedAtGte value in PaymentsRequest', 0, 'PaymentRequest.capturedAtGte' + 'Invalid capturedAtGte value in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtGte' ); } $this->_capturedAtGte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid capturedAtGte value type in PaymentsRequest', 0, 'PaymentRequest.capturedAtGte' + 'Invalid capturedAtGte value type in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtGte' ); } } @@ -380,13 +400,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid capturedAtGt value in PaymentsRequest', 0, 'PaymentRequest.capturedAtGt' + 'Invalid capturedAtGt value in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtGt' ); } $this->_capturedAtGt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid capturedAtGt value type in PaymentsRequest', 0, 'PaymentRequest.capturedAtGt' + 'Invalid capturedAtGt value type in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtGt' ); } } @@ -426,13 +450,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid capturedAtLte value in PaymentsRequest', 0, 'PaymentRequest.capturedAtLte' + 'Invalid capturedAtLte value in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtLte' ); } $this->_capturedAtLte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid capturedAtLte value type in PaymentsRequest', 0, 'PaymentRequest.capturedAtLte' + 'Invalid capturedAtLte value type in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtLte' ); } } @@ -472,13 +500,17 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid capturedAtLt value in PaymentsRequest', 0, 'PaymentRequest.capturedAtLt' + 'Invalid capturedAtLt value in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtLt' ); } $this->_capturedAtLt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid capturedAlLt value type in PaymentsRequest', 0, 'PaymentRequest.capturedAtLt' + 'Invalid capturedAlLt value type in PaymentsRequest', + 0, + 'PaymentRequest.capturedAtLt' ); } } @@ -515,14 +547,20 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac } elseif (TypeCast::canCastToEnumString($value)) { if (!PaymentStatus::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid status value in PaymentsRequest', 0, 'PaymentsRequest.status', $value + 'Invalid status value in PaymentsRequest', + 0, + 'PaymentsRequest.status', + $value ); } else { $this->_status = (string)$value; } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value in PaymentsRequest', 0, 'PaymentsRequest.status', $value + 'Invalid status value in PaymentsRequest', + 0, + 'PaymentsRequest.status', + $value ); } } @@ -559,14 +597,20 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac } elseif (TypeCast::canCastToEnumString($value)) { if (!PaymentMethodType::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid status value in PaymentsRequest', 0, 'PaymentsRequest.paymentMethod', $value + 'Invalid status value in PaymentsRequest', + 0, + 'PaymentsRequest.paymentMethod', + $value ); } else { $this->_paymentMethod = (string)$value; } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in PaymentsRequest', 0, 'PaymentsRequest.paymentMethod', $value + 'Invalid status value type in PaymentsRequest', + 0, + 'PaymentsRequest.paymentMethod', + $value ); } } @@ -602,13 +646,19 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac } elseif (is_int($value)) { if ($value < 0 || $value > self::MAX_LIMIT_VALUE) { throw new InvalidPropertyValueException( - 'Invalid limit value in PaymentsRequest', 0, 'PaymentsRequest.limit', $value + 'Invalid limit value in PaymentsRequest', + 0, + 'PaymentsRequest.limit', + $value ); } $this->_limit = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid limit value type in PaymentsRequest', 0, 'PaymentsRequest.limit', $value + 'Invalid limit value type in PaymentsRequest', + 0, + 'PaymentsRequest.limit', + $value ); } } @@ -645,7 +695,10 @@ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterfac $this->_cursor = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in PaymentsRequest', 0, 'PaymentsRequest.limit', $value + 'Invalid cursor value type in PaymentsRequest', + 0, + 'PaymentsRequest.cursor', + $value ); } } diff --git a/lib/Request/Payments/PaymentsRequestBuilder.php b/lib/Request/Payments/PaymentsRequestBuilder.php index 53f5511b..8dc23fe3 100644 --- a/lib/Request/Payments/PaymentsRequestBuilder.php +++ b/lib/Request/Payments/PaymentsRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Payments/PaymentsRequestInterface.php b/lib/Request/Payments/PaymentsRequestInterface.php index 8e3459ba..642de4c5 100644 --- a/lib/Request/Payments/PaymentsRequestInterface.php +++ b/lib/Request/Payments/PaymentsRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -50,227 +50,227 @@ interface PaymentsRequestInterface * Возвращает страницу выдачи результатов или null, если она до этого не была установлена * @return string|null Страница выдачи результатов */ - function getCursor(); + public function getCursor(); /** * Проверяет, была ли установлена страница выдачи результатов * @return bool True если страница выдачи результатов была установлена, false если нет */ - function hasCursor(); + public function hasCursor(); /** * Устанавливает страницу выдачи результатов * @param string $value Страница * @return void */ - function setCursor($value); + public function setCursor($value); /** * Возвращает ограничение количества объектов платежа или null, если оно до этого не было установлено * @return string|null Ограничение количества объектов платежа */ - function getLimit(); + public function getLimit(); /** * Проверяет, было ли установлено ограничение количества объектов платежа * @return bool True если ограничение количества объектов платежа было установлено, false если нет */ - function hasLimit(); + public function hasLimit(); /** * Устанавливает ограничение количества объектов платежа * @param int $value Количества объектов платежа на странице * @return void */ - function setLimit($value); + public function setLimit($value); /** * Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, от (включительно) */ - function getCreatedAtGte(); + public function getCreatedAtGte(); /** * Проверяет, была ли установлена дата создания от которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGte(); + public function hasCreatedAtGte(); /** * Устанавливает дату создания от которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCreatedAtGte($value); + public function setCreatedAtGte($value); /** * Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, от (не включая) */ - function getCreatedAtGt(); + public function getCreatedAtGt(); /** * Проверяет, была ли установлена дата создания от которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGt(); + public function hasCreatedAtGt(); /** * Устанавливает дату создания от которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCreatedAtGt($value); + public function setCreatedAtGt($value); /** * Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, до (включительно) */ - function getCreatedAtLte(); + public function getCreatedAtLte(); /** * Проверяет, была ли установлена дата создания до которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLte(); + public function hasCreatedAtLte(); /** * Устанавливает дату создания до которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCreatedAtLte($value); + public function setCreatedAtLte($value); /** * Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, до (не включая) */ - function getCreatedAtLt(); + public function getCreatedAtLt(); /** * Проверяет, была ли установлена дата создания до которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLt(); + public function hasCreatedAtLt(); /** * Устанавливает дату создания до которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCreatedAtLt($value); + public function setCreatedAtLt($value); /** * Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, от (включительно) */ - function getCapturedAtGte(); + public function getCapturedAtGte(); /** * Проверяет, была ли установлена дата создания от которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCapturedAtGte(); + public function hasCapturedAtGte(); /** * Устанавливает дату создания от которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCapturedAtGte($value); + public function setCapturedAtGte($value); /** * Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, от (не включая) */ - function getCapturedAtGt(); + public function getCapturedAtGt(); /** * Проверяет, была ли установлена дата создания от которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCapturedAtGt(); + public function hasCapturedAtGt(); /** * Устанавливает дату создания от которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCapturedAtGt($value); + public function setCapturedAtGt($value); /** * Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, до (включительно) */ - function getCapturedAtLte(); + public function getCapturedAtLte(); /** * Проверяет, была ли установлена дата создания до которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCapturedAtLte(); + public function hasCapturedAtLte(); /** * Устанавливает дату создания до которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCapturedAtLte($value); + public function setCapturedAtLte($value); /** * Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена * @return \DateTime|null Время создания, до (не включая) */ - function getCapturedAtLt(); + public function getCapturedAtLt(); /** * Проверяет, была ли установлена дата создания до которой выбираются платежи * @return bool True если дата была установлена, false если нет */ - function hasCapturedAtLt(); + public function hasCapturedAtLt(); /** * Устанавливает дату создания до которой выбираются платежи * @param \DateTime $value Дата * @return void */ - function setCapturedAtLt($value); + public function setCapturedAtLt($value); /** * Возвращает статус выбираемых платежей или null, если он до этого не был установлен * @return string|null Статус выбираемых платежей */ - function getStatus(); + public function getStatus(); /** * Проверяет, был ли установлен статус выбираемых платежей * @return bool True если статус был установлен, false если нет */ - function hasStatus(); + public function hasStatus(); /** * Устанавливает статус выбираемых платежей * @param string $value Статус платежей * @return void */ - function setStatus($value); + public function setStatus($value); /** * Возвращает код способа оплаты выбираемых платежей или null, если он до этого не был установлен * @return string|null Код способа оплаты выбираемых платежей */ - function getPaymentMethod(); + public function getPaymentMethod(); /** * Проверяет, был ли установлен код способа оплаты выбираемых платежей * @return bool True если код способа оплаты был установлен, false если нет */ - function hasPaymentMethod(); + public function hasPaymentMethod(); /** * Устанавливает код способа оплаты выбираемых платежей * @param string $value Код способа оплаты * @return void */ - function setPaymentMethod($value); + public function setPaymentMethod($value); } diff --git a/lib/Request/Payments/PaymentsRequestSerializer.php b/lib/Request/Payments/PaymentsRequestSerializer.php index 1194a2b1..be35595f 100644 --- a/lib/Request/Payments/PaymentsRequestSerializer.php +++ b/lib/Request/Payments/PaymentsRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Payments/PaymentsResponse.php b/lib/Request/Payments/PaymentsResponse.php index 6cc3b9bf..a45b3f98 100644 --- a/lib/Request/Payments/PaymentsResponse.php +++ b/lib/Request/Payments/PaymentsResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -90,5 +90,4 @@ class PaymentsResponse extends AbstractObject { return $this->nextCursor !== null; } - } diff --git a/lib/Request/Payouts/AbstractPayoutResponse.php b/lib/Request/Payouts/AbstractPayoutResponse.php index 7340e2ed..5f0a764f 100644 --- a/lib/Request/Payouts/AbstractPayoutResponse.php +++ b/lib/Request/Payouts/AbstractPayoutResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -34,5 +34,6 @@ use YooKassa\Model\PayoutInterface; * * @package YooKassa */ -abstract class AbstractPayoutResponse extends Payout implements PayoutInterface -{} +abstract class AbstractPayoutResponse extends Payout +{ +} diff --git a/lib/Request/Payouts/CreatePayoutRequest.php b/lib/Request/Payouts/CreatePayoutRequest.php index ac77874d..5ea18c32 100644 --- a/lib/Request/Payouts/CreatePayoutRequest.php +++ b/lib/Request/Payouts/CreatePayoutRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -52,8 +52,16 @@ use YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataFactory; * @property AbstractPayoutDestination $payout_destination_data Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. * @property string $payoutToken Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data * @property string $payout_token Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data + * @property string $payment_method_id Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты + * @property string $paymentMethodId Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты * @property PayoutDealInfo $deal Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку * @property string $description Описание транзакции (не более 128 символов). Например: «Выплата по договору N» + * @property PayoutSelfEmployedInfo $self_employed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property PayoutSelfEmployedInfo $selfEmployed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property IncomeReceiptData $receipt_data Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property IncomeReceiptData $receiptData Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property PayoutPersonalData $personal_data Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). + * @property PayoutPersonalData $personalData Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). * @property Metadata $metadata Метаданные привязанные к выплате */ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequestInterface @@ -66,13 +74,24 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest /** * @var AbstractPayoutDestination Данные платежного средства, на которое нужно сделать выплату */ - private $_payoutDestinationData; + private $_payout_destination_data; /** * @var string Токенизированные данные для выплаты */ private $_payoutToken; + /** + * Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты. + * + * [Подробнее о выплатах с использованием идентификатора сохраненного способа оплаты](https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token) + * + * Обязательный параметр, если не передан payout_destination_data или payout_token. + * + * @var string|null + */ + private $_payment_method_id; + /** * @var PayoutDealInfo Сделка, в рамках которой нужно провести выплату */ @@ -83,6 +102,27 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest */ private $_description; + /** + * Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * + * @var PayoutSelfEmployedInfo|null + */ + private $_self_employed; + + /** + * Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * + * @var IncomeReceiptData|null + */ + private $_receipt_data; + + /** + * Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). + * + * @var PayoutPersonalData[]|null + */ + private $_personal_data; + /** * @var Metadata Метаданные привязанные к выплате */ @@ -108,7 +148,7 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest /** * Устанавливает сумму выплаты - * @param AmountInterface|array|string|null Сумма выплаты + * @param AmountInterface|array|string|numeric|null $value Сумма выплаты * * @throws InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа */ @@ -116,13 +156,18 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest { if ($value === null || $value === '') { throw new EmptyPropertyValueException('Empty amount value', 0, 'CreatePayoutRequest.amount'); - } elseif ($value instanceof AmountInterface) { + } + if ($value instanceof AmountInterface) { $this->_amount = $value; } elseif (is_numeric($value) || is_array($value)) { $this->_amount = new MonetaryAmount($value); } else { throw new InvalidPropertyValueTypeException('Invalid amount value type in CreatePayoutRequest', 0, 'CreatePayoutRequest.amount', $value); } + $value = $this->_amount->getValue(); + if (empty($value) || $value <= 0.0) { + throw new InvalidPropertyValueException('Invalid amount value in CreatePayoutRequest', 0, 'CreatePayoutRequest.amount', $value); + } } /** @@ -131,7 +176,7 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest */ public function getPayoutDestinationData() { - return $this->_payoutDestinationData; + return $this->_payout_destination_data; } /** @@ -140,7 +185,7 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest */ public function hasPayoutDestinationData() { - return !empty($this->_payoutDestinationData); + return !empty($this->_payout_destination_data); } /** @@ -152,12 +197,12 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest public function setPayoutDestinationData($value) { if ($value === null || $value === '') { - $this->_payoutDestinationData = null; + $this->_payout_destination_data = null; } elseif ($value instanceof AbstractPayoutDestinationData) { - $this->_payoutDestinationData = $value; + $this->_payout_destination_data = $value; } elseif (is_array($value)) { $factory = new PayoutDestinationDataFactory(); - $this->_payoutDestinationData = $factory->factoryFromArray($value); + $this->_payout_destination_data = $factory->factoryFromArray($value); } else { throw new InvalidPropertyValueTypeException( 'Invalid payoutDestinationData value type in CreatePayoutRequest', @@ -169,8 +214,8 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest } /** - * Проверяет наличие токенизированных данных для выплаты - * @return bool True если токен установлен, false если нет + * Возвращает токенизированные данные для выплаты + * @return string Токенизированные данные для выплаты */ public function getPayoutToken() { @@ -178,7 +223,7 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest } /** - * Проверяет наличие одноразового токена для проведения оплаты + * Проверяет наличие токенизированных данных для выплаты * @return bool True если токен установлен, false если нет */ public function hasPayoutToken() @@ -200,11 +245,58 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest $this->_payoutToken = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payoutToken value type', 0, 'CreatePayoutRequest.payoutToken', $value + 'Invalid payoutToken value type', + 0, + 'CreatePayoutRequest.payoutToken', + $value ); } } + /** + * Возвращает идентификатор сохраненного способа оплаты. + * + * @return string|null Идентификатор сохраненного способа оплаты + */ + public function getPaymentMethodId() + { + return $this->_payment_method_id; + } + + /** + * Проверяет наличие идентификатора сохраненного способа оплаты + * @return bool True если идентификатора установлен, false если нет + */ + public function hasPaymentMethodId() + { + return !empty($this->_payment_method_id); + } + + /** + * Устанавливает идентификатор сохраненного способа оплаты. + * + * @param string|null $value Идентификатор сохраненного способа оплаты + * + * @return $this + */ + public function setPaymentMethodId($value = null) + { + if ($value === null || $value === '') { + $this->_payment_method_id = null; + } elseif (TypeCast::canCastToString($value)) { + $this->_payment_method_id = (string)$value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid payment_method_id value type', + 0, + 'CreatePayoutRequest.payment_method_id', + $value + ); + } + + return $this; + } + /** * Возвращает сделку, в рамках которой нужно провести выплату * @return PayoutDealInfo Сделка, в рамках которой нужно провести выплату @@ -237,12 +329,164 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest $this->_deal = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid value type for "deal" parameter in CreatePayoutRequest', 0, 'CreatePayoutRequest.deal', $value + 'Invalid value type for "deal" parameter in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.deal', + $value ); } return $this; } + /** + * Возвращает данные самозанятого, который получит выплату. + * + * @return PayoutSelfEmployedInfo|null Данные самозанятого, который получит выплату + */ + public function getSelfEmployed() + { + return $this->_self_employed; + } + /** + * Проверяет наличие данных самозанятого в создаваемой выплате + * @return bool True если данные самозанятого есть, false если нет + */ + public function hasSelfEmployed() + { + return !empty($this->_self_employed); + } + + /** + * Устанавливает данные самозанятого, который получит выплату. + * + * @param PayoutSelfEmployedInfo|array|null $value Данные самозанятого, который получит выплату + * + * @return $this + */ + public function setSelfEmployed($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_self_employed = null; + } elseif (is_array($value)) { + $this->_self_employed = new PayoutSelfEmployedInfo($value); + } elseif ($value instanceof PayoutSelfEmployedInfo) { + $this->_self_employed = $value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "self_employed" parameter in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.self_employed', + $value + ); + } + + return $this; + } + + /** + * Возвращает данные для формирования чека в сервисе Мой налог. + * + * @return IncomeReceiptData|null Данные для формирования чека в сервисе Мой налог + */ + public function getReceiptData() + { + return $this->_receipt_data; + } + + /** + * Проверяет наличие данных для формирования чека в сервисе Мой налог. + * @return bool True если данные для формирования чека есть, false если нет + */ + public function hasReceiptData() + { + return !empty($this->_receipt_data); + } + + /** + * Устанавливает данные для формирования чека в сервисе Мой налог. + * + * @param IncomeReceiptData|array|null $value Данные для формирования чека в сервисе Мой налог + * + * @return $this + */ + public function setReceiptData($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_receipt_data = null; + } elseif (is_array($value)) { + $this->_receipt_data = new IncomeReceiptData($value); + } elseif ($value instanceof IncomeReceiptData) { + $this->_receipt_data = $value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "receipt_data" parameter in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.receipt_data', + $value + ); + } + + return $this; + } + + /** + * Возвращает персональные данные получателя выплаты. + * + * @return PayoutPersonalData[]|null Персональные данные получателя выплаты + */ + public function getPersonalData() + { + return $this->_personal_data; + } + + /** + * Проверяет наличие персональных данных в создаваемой выплате + * @return bool True если персональные данные есть, false если нет + */ + public function hasPersonalData() + { + return !empty($this->_personal_data); + } + + /** + * Устанавливает персональные данные получателя выплаты. + * + * @param PayoutPersonalData[]|array|null $value Персональные данные получателя выплаты + * + * @return $this + */ + public function setPersonalData($value = null) + { + if ($value === null || (is_array($value) && empty($value))) { + $this->_personal_data = null; + return $this; + } + if (!is_array($value) && !($value instanceof \Traversable)) { + throw new InvalidPropertyValueTypeException( + 'Invalid personal_data value type in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.personal_data', + $value + ); + } + $this->_personal_data = array(); + foreach ($value as $key => $val) { + if ($val instanceof PayoutPersonalData) { + $this->_personal_data[] = $val; + } elseif (is_array($val)) { + $this->_personal_data[] = new PayoutPersonalData($val); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid personal_data value type in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.personal_data[' . $key . ']', + $val + ); + } + } + + return $this; + } /** * Возвращает описание транзакции @@ -286,7 +530,10 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type', 0, 'CreatePayoutRequest.description', $value + 'Invalid description value type', + 0, + 'CreatePayoutRequest.description', + $value ); } } @@ -326,7 +573,10 @@ class CreatePayoutRequest extends AbstractRequest implements CreatePayoutRequest $this->_metadata = new Metadata($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid metadata value type in CreatePayoutRequest', 0, 'CreatePayoutRequest.metadata', $value + 'Invalid metadata value type in CreatePayoutRequest', + 0, + 'CreatePayoutRequest.metadata', + $value ); } } diff --git a/lib/Request/Payouts/CreatePayoutRequestBuilder.php b/lib/Request/Payouts/CreatePayoutRequestBuilder.php index dbf508ce..8a3d348e 100644 --- a/lib/Request/Payouts/CreatePayoutRequestBuilder.php +++ b/lib/Request/Payouts/CreatePayoutRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -100,6 +100,19 @@ class CreatePayoutRequestBuilder extends AbstractRequestBuilder return $this; } + /** + * Устанавливает идентификатор сохраненного способа оплаты. + * + * @param string|null $value Идентификатор сохраненного способа оплаты + * + * @throws InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа + */ + public function setPaymentMethodId($value) + { + $this->currentObject->setPaymentMethodId($value); + return $this; + } + /** * Устанавливает сделку, в рамках которой нужно провести выплату * @param PayoutDealInfo|array $value Сделка, в рамках которой нужно провести выплату @@ -112,6 +125,45 @@ class CreatePayoutRequestBuilder extends AbstractRequestBuilder return $this; } + /** + * Устанавливает данные самозанятого, который получит выплату. + * + * @param PayoutSelfEmployedInfo|array|null $value Данные самозанятого, который получит выплату + * + * @throws InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа + */ + public function setSelfEmployed($value) + { + $this->currentObject->setSelfEmployed($value); + return $this; + } + + /** + * Устанавливает данные для формирования чека в сервисе Мой налог. + * + * @param IncomeReceiptData|array|null $value Данные для формирования чека в сервисе Мой налог + * + * @throws InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа + */ + public function setReceiptData($value) + { + $this->currentObject->setReceiptData($value); + return $this; + } + + /** + * Устанавливает персональные данные получателя выплаты. + * + * @param PayoutPersonalData[]|array|null $value Персональные данные получателя выплаты + * + * @throws InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа + */ + public function setPersonalData($value) + { + $this->currentObject->setPersonalData($value); + return $this; + } + /** * Устанавливает метаданные, привязанные к платежу * @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом @@ -151,5 +203,4 @@ class CreatePayoutRequestBuilder extends AbstractRequestBuilder { return parent::build($options); } - } diff --git a/lib/Request/Payouts/CreatePayoutRequestInterface.php b/lib/Request/Payouts/CreatePayoutRequestInterface.php index 99bc3a57..dd0e468d 100644 --- a/lib/Request/Payouts/CreatePayoutRequestInterface.php +++ b/lib/Request/Payouts/CreatePayoutRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -27,7 +27,6 @@ namespace YooKassa\Request\Payouts; use YooKassa\Model\AmountInterface; -use YooKassa\Model\DealInterface; use YooKassa\Model\Metadata; use YooKassa\Model\MonetaryAmount; use YooKassa\Model\Deal\PayoutDealInfo; @@ -43,8 +42,16 @@ use YooKassa\Model\Payout\AbstractPayoutDestination; * @property AbstractPayoutDestination $payout_destination_data Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. * @property string $payoutToken Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data * @property string $payout_token Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data - * @property DealInterface $deal Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку + * @property string $payment_method_id Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты + * @property string $paymentMethodId Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты + * @property PayoutDealInfo $deal Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку * @property string $description Описание транзакции (не более 128 символов). Например: «Выплата по договору N» + * @property PayoutSelfEmployedInfo $self_employed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property PayoutSelfEmployedInfo $selfEmployed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property IncomeReceiptData $receipt_data Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property IncomeReceiptData $receiptData Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. + * @property PayoutPersonalData $personal_data Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). + * @property PayoutPersonalData $personalData Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). * @property Metadata $metadata Метаданные привязанные к выплате */ interface CreatePayoutRequestInterface @@ -53,107 +60,195 @@ interface CreatePayoutRequestInterface * Возвращает сумму выплаты * @return AmountInterface|MonetaryAmount Сумма выплаты */ - function getAmount(); + public function getAmount(); /** * Проверяет наличие суммы в создаваемой выплате * @return bool True если сумма установлена, false если нет */ - function hasAmount(); + public function hasAmount(); /** * Устанавливает сумму выплаты - * @param AmountInterface|array Сумма выплаты + * @param AmountInterface|array $value Сумма выплаты */ - function setAmount($value); + public function setAmount($value); /** * Возвращает данные платежного средства, на которое нужно сделать выплату * @return AbstractPayoutDestination|null Данные платежного средства, на которое нужно сделать выплату */ - function getPayoutDestinationData(); + public function getPayoutDestinationData(); /** * Проверяет наличие данных платежного средства, на которое нужно сделать выплату * @return bool True если данные есть, false если нет */ - function hasPayoutDestinationData(); + public function hasPayoutDestinationData(); /** * Устанавливает данные платежного средства, на которое нужно сделать выплату * @param AbstractPayoutDestination|array|null $value Данные платежного средства, на которое нужно сделать выплату */ - function setPayoutDestinationData($value); + public function setPayoutDestinationData($value); /** * Возвращает токенизированные данные для выплаты * @return string Токенизированные данные для выплаты */ - function getPayoutToken(); + public function getPayoutToken(); /** * Проверяет наличие токенизированных данных для выплаты * @return bool True если токен установлен, false если нет */ - function hasPayoutToken(); + public function hasPayoutToken(); /** * Устанавливает токенизированные данные для выплаты * @param string $value Токенизированные данные для выплаты */ - function setPayoutToken($value); + public function setPayoutToken($value); + + /** + * Возвращает идентификатор сохраненного способа оплаты. + * + * @return string|null Идентификатор сохраненного способа оплаты + */ + public function getPaymentMethodId(); + + /** + * Проверяет наличие идентификатора сохраненного способа оплаты + * @return bool True если идентификатора установлен, false если нет + */ + public function hasPaymentMethodId(); + + /** + * Устанавливает идентификатор сохраненного способа оплаты. + * + * @param string|null $value Идентификатор сохраненного способа оплаты + * + * @return $this + */ + public function setPaymentMethodId($value = null); /** * Возвращает описание транзакции * @return string Описание транзакции */ - function getDescription(); + public function getDescription(); /** * Проверяет наличие описания транзакции в создаваемой выплате * @return bool True если описание транзакции установлено, false если нет */ - function hasDescription(); + public function hasDescription(); /** * Устанавливает описание транзакции * @param string $value Описание транзакции */ - function setDescription($value); + public function setDescription($value); /** * Возвращает сделку, в рамках которой нужно провести выплату * @return PayoutDealInfo|null Сделка, в рамках которой нужно провести выплату */ - function getDeal(); + public function getDeal(); /** * Проверяет установлена ли сделка, в рамках которой нужно провести выплату * @return bool True если сделка установлена, false если нет */ - function hasDeal(); + public function hasDeal(); /** * Устанавливает сделку, в рамках которой нужно провести выплату * @param PayoutDealInfo|array|null $value Сделка, в рамках которой нужно провести выплату */ - function setDeal($value); + public function setDeal($value); + + /** + * Возвращает данные самозанятого, который получит выплату. + * + * @return PayoutSelfEmployedInfo|null Данные самозанятого, который получит выплату + */ + public function getSelfEmployed(); + + /** + * Проверяет наличие данных самозанятого в создаваемой выплате + * @return bool True если данные самозанятого есть, false если нет + */ + public function hasSelfEmployed(); + + /** + * Устанавливает данные самозанятого, который получит выплату. + * + * @param PayoutSelfEmployedInfo|array|null $value Данные самозанятого, который получит выплату + * + * @return $this + */ + public function setSelfEmployed($value = null); + + /** + * Возвращает данные для формирования чека в сервисе Мой налог. + * + * @return IncomeReceiptData|null Данные для формирования чека в сервисе Мой налог + */ + public function getReceiptData(); + + /** + * Проверяет наличие данных для формирования чека в сервисе Мой налог. + * @return bool True если данные для формирования чека есть, false если нет + */ + public function hasReceiptData(); + + /** + * Устанавливает данные для формирования чека в сервисе Мой налог.. + * + * @param IncomeReceiptData|array|null $value Данные для формирования чека в сервисе Мой налог. + * + * @return $this + */ + public function setReceiptData($value = null); + + /** + * Возвращает персональные данные получателя выплаты. + * + * @return PayoutPersonalData[]|null Персональные данные получателя выплаты + */ + public function getPersonalData(); + + /** + * Проверяет наличие персональных данных в создаваемой выплате + * @return bool True если персональные данные есть, false если нет + */ + public function hasPersonalData(); + + /** + * Устанавливает персональные данные получателя выплаты. + * + * @param PayoutPersonalData[]|array|null $value Персональные данные получателя выплаты + * + * @return $this + */ + public function setPersonalData($value = null); /** * Возвращает данные оплаты установленные мерчантом * @return Metadata Метаданные привязанные к выплате */ - function getMetadata(); + public function getMetadata(); /** * Проверяет, были ли установлены метаданные заказа * @return bool True если метаданные были установлены, false если нет */ - function hasMetadata(); + public function hasMetadata(); /** * Устанавливает метаданные, привязанные к выплате * @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом */ - function setMetadata($value); + public function setMetadata($value); } diff --git a/lib/Request/Payouts/CreatePayoutRequestSerializer.php b/lib/Request/Payouts/CreatePayoutRequestSerializer.php index 4b0fdec3..d69e17e0 100644 --- a/lib/Request/Payouts/CreatePayoutRequestSerializer.php +++ b/lib/Request/Payouts/CreatePayoutRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,13 +47,13 @@ class CreatePayoutRequestSerializer $result['amount'] = $request->getAmount()->toArray(); } if ($request->hasPayoutDestinationData()) { - $result['payout_destination_data'] = $request->getPayoutDestinationData()->toArray(); + $result['payout_destination_data'] = $request->getPayoutDestinationdata()->toArray(); } if ($request->hasPayoutToken()) { $result['payout_token'] = $request->getPayoutToken(); } - if ($request->hasMetadata()) { - $result['metadata'] = $request->getMetadata()->toArray(); + if ($request->hasPaymentMethodid()) { + $result['payment_method_id'] = $request->getPaymentMethodid(); } if ($request->hasDescription()) { $result['description'] = $request->getDescription(); @@ -61,6 +61,17 @@ class CreatePayoutRequestSerializer if ($request->hasDeal()) { $result['deal'] = $request->getDeal()->toArray(); } + if ($request->hasSelfEmployed()) { + $result['self_employed'] = $request->getSelfEmployed()->toArray(); + } + if ($request->hasReceiptData()) { + $result['receipt_data'] = $request->getReceiptData()->toArray(); + } + if ($request->hasPersonalData()) { + foreach ($request->getPersonalData() as $item) { + $result['personal_data'][] = $item->toArray(); + } + } if ($request->hasMetadata()) { $result['metadata'] = $request->getMetadata()->toArray(); } diff --git a/lib/Request/Payouts/CreatePayoutResponse.php b/lib/Request/Payouts/CreatePayoutResponse.php index c02f4d39..c2298f79 100644 --- a/lib/Request/Payouts/CreatePayoutResponse.php +++ b/lib/Request/Payouts/CreatePayoutResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Payouts; * @package YooKassa */ class CreatePayoutResponse extends AbstractPayoutResponse -{} +{ +} diff --git a/lib/Request/Payouts/IncomeReceiptData.php b/lib/Request/Payouts/IncomeReceiptData.php new file mode 100644 index 00000000..6376f676 --- /dev/null +++ b/lib/Request/Payouts/IncomeReceiptData.php @@ -0,0 +1,138 @@ +_service_name; + } + + /** + * Устанавливает описание услуги, оказанной получателем выплаты. + * + * @param string $value Описание услуги, оказанной получателем выплаты + * + * @return $this + */ + public function setServiceName($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException('Empty service_name value', 0, 'IncomeReceiptData.service_name'); + } + if (!TypeCast::canCastToString($value)) { + throw new InvalidPropertyValueTypeException('Invalid IncomeReceiptData service_name value type', 0, 'IncomeReceiptData.id', $value); + } + if (mb_strlen($value, 'utf-8') > IncomeReceipt::MAX_LENGTH_SERVICE_NAME) { + throw new InvalidPropertyValueException('Invalid IncomeReceiptData service_name value', 0, 'IncomeReceiptData.service_name', $value); + } + $this->_service_name = (string)$value; + + return $this; + } + + /** + * Возвращает сумму для печати в чеке. + * + * @return AmountInterface|null Сумма для печати в чеке + */ + public function getAmount() + { + return $this->_amount; + } + + /** + * Устанавливает сумму для печати в чеке. + * + * @param AmountInterface|array|null $value Сумма для печати в чеке + * + * @return $this + */ + public function setAmount($value = null) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException('Empty amount value', 0, 'IncomeReceiptData.amount'); + } + if ($value instanceof AmountInterface) { + $this->_amount = $value; + } elseif (is_array($value)) { + $this->_amount = new MonetaryAmount($value); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid IncomeReceiptData.amount value type', + 0, + 'IncomeReceiptData.amount', + $value + ); + } + + return $this; + } +} diff --git a/lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php b/lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php index d48299e7..8c20dec7 100644 --- a/lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php +++ b/lib/Request/Payouts/PayoutDestinationData/AbstractPayoutDestinationData.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -33,4 +33,5 @@ use YooKassa\Model\Payout\AbstractPayoutDestination; * @property string $type Тип метода оплаты */ abstract class AbstractPayoutDestinationData extends AbstractPayoutDestination -{} +{ +} diff --git a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php index a2afe2ff..eca104e4 100644 --- a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php +++ b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -45,7 +45,7 @@ class PayoutDestinationDataBankCard extends AbstractPayoutDestinationData public function __construct() { - $this->_setType(PaymentMethodType::BANK_CARD); + $this->setType(PaymentMethodType::BANK_CARD); } /** @@ -75,7 +75,10 @@ class PayoutDestinationDataBankCard extends AbstractPayoutDestinationData $this->_card = $card; } else { throw new InvalidPropertyValueTypeException( - 'Invalid card value type in PayoutDestinationBankCard', 0, 'PayoutDestinationBankCard.card', $value + 'Invalid card value type in PayoutDestinationBankCard', + 0, + 'PayoutDestinationBankCard.card', + $value ); } } diff --git a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php index e07b862d..c823b94e 100644 --- a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php +++ b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataBankCardCard.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -67,14 +67,19 @@ class PayoutDestinationDataBankCardCard extends AbstractObject $this->_number = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid card number value', 0, 'PayoutDestinationBankCardCard.number', $value + 'Invalid card number value', + 0, + 'PayoutDestinationBankCardCard.number', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid card number value type', 0, 'PayoutDestinationBankCardCard.number', $value + 'Invalid card number value type', + 0, + 'PayoutDestinationBankCardCard.number', + $value ); } } - } diff --git a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataFactory.php b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataFactory.php index 201df32a..0f6f0af4 100644 --- a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataFactory.php +++ b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -38,8 +38,9 @@ use YooKassa\Model\PaymentMethodType; class PayoutDestinationDataFactory { private $typeClassMap = array( - PaymentMethodType::YOO_MONEY => 'PayoutDestinationDataYooMoney', - PaymentMethodType::BANK_CARD => 'PayoutDestinationDataBankCard', + PaymentMethodType::YOO_MONEY => 'PayoutDestinationDataYooMoney', + PaymentMethodType::BANK_CARD => 'PayoutDestinationDataBankCard', + PaymentMethodType::SBP => 'PayoutDestinationDataSbp', ); /** @@ -54,9 +55,9 @@ class PayoutDestinationDataFactory throw new \InvalidArgumentException('Invalid payment type value in payment factory'); } if (!array_key_exists($type, $this->typeClassMap)) { - throw new \InvalidArgumentException('Invalid payment data type "'.$type.'"'); + throw new \InvalidArgumentException('Invalid payment data type "' . $type . '"'); } - $className = __NAMESPACE__.'\\'.$this->typeClassMap[$type]; + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; return new $className(); } diff --git a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataSbp.php b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataSbp.php new file mode 100644 index 00000000..a268b60b --- /dev/null +++ b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataSbp.php @@ -0,0 +1,133 @@ +setType(PaymentMethodType::SBP); + } + + /** + * Возвращает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + * + * @return string Телефон, к которому привязан счет получателя выплаты в системе участника СБП + */ + public function getPhone() + { + return $this->_phone; + } + + /** + * Устанавливает телефон, к которому привязан счет получателя выплаты в системе участника СБП. + * + * @param string $phone Телефон, к которому привязан счет получателя выплаты в системе участника СБП + * + * @return $this + */ + public function setPhone($phone) + { + if ($phone === null || $phone === '') { + throw new EmptyPropertyValueException('Empty phone value', 0, 'PayoutDestinationDataSbp.phone'); + } + if (!TypeCast::canCastToString($phone)) { + throw new InvalidPropertyValueTypeException('Invalid phone value type', 0, 'PayoutDestinationDataSbp.phone'); + } + $this->_phone = (string)preg_replace('/\D/', '', $phone); + + return $this; + } + + /** + * Возвращает идентификатор выбранного участника СБП. + * + * @return string Идентификатор выбранного участника СБП + */ + public function getBankId() + { + return $this->_bank_id; + } + + /** + * Устанавливает идентификатор выбранного участника СБП. + * + * @param string $bankId Идентификатор выбранного участника СБП + * + * @return $this + */ + public function setBankId($bankId) + { + if ($bankId === null || $bankId === '') { + throw new EmptyPropertyValueException('Empty bank_id value', 0, 'PayoutDestinationDataSbp.bank_id'); + } + if (!TypeCast::canCastToString($bankId)) { + throw new InvalidPropertyValueTypeException('Invalid bank_id value type', 0, 'PayoutDestinationDataSbp.bank_id', $bankId); + } + if (mb_strlen($bankId) > 12) { + throw new InvalidPropertyValueException('Invalid bank_id value', 0, 'PayoutDestinationDataSbp.bank_id', $bankId); + } + $this->_bank_id = (string)$bankId; + + return $this; + } +} diff --git a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php index 4e0161bd..7d8445fa 100644 --- a/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php +++ b/lib/Request/Payouts/PayoutDestinationData/PayoutDestinationDataYooMoney.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -50,7 +50,7 @@ class PayoutDestinationDataYooMoney extends AbstractPayoutDestinationData public function __construct() { - $this->_setType(PaymentMethodType::YOO_MONEY); + $this->setType(PaymentMethodType::YOO_MONEY); } /** @@ -70,19 +70,27 @@ class PayoutDestinationDataYooMoney extends AbstractPayoutDestinationData { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty accountNumber value', 0, 'PayoutDestinationYooMoney.accountNumber' + 'Empty accountNumber value', + 0, + 'PayoutDestinationYooMoney.accountNumber' ); } elseif (TypeCast::canCastToString($value)) { if (preg_match('/^[0-9]{11,33}$/', $value)) { $this->_accountNumber = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid accountNumber value', 0, 'PayoutDestinationYooMoney.accountNumber', $value + 'Invalid accountNumber value', + 0, + 'PayoutDestinationYooMoney.accountNumber', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid accountNumber value type', 0, 'PayoutDestinationYooMoney.accountNumber', $value + 'Invalid accountNumber value type', + 0, + 'PayoutDestinationYooMoney.accountNumber', + $value ); } } diff --git a/lib/Request/Payouts/PayoutPersonalData.php b/lib/Request/Payouts/PayoutPersonalData.php new file mode 100644 index 00000000..84a8f8e1 --- /dev/null +++ b/lib/Request/Payouts/PayoutPersonalData.php @@ -0,0 +1,84 @@ +_id; + } + + /** + * Устанавливает идентификатор персональных данных. + * + * @param string $id Идентификатор персональных данных + * + * @return $this + */ + public function setId($id) + { + if (!TypeCast::canCastToString($id)) { + throw new InvalidPropertyValueTypeException('Invalid PayoutPersonalData id value type', 0, 'PayoutPersonalData.id', $id); + } + $length = mb_strlen($id, 'utf-8'); + if ($length < PersonalDataInterface::MIN_LENGTH_ID || $length > PersonalDataInterface::MAX_LENGTH_ID) { + throw new InvalidPropertyValueException('Invalid PayoutPersonalData id value', 0, 'PayoutPersonalData.id', $id); + } + $this->_id = (string)$id; + + return $this; + } +} diff --git a/lib/Request/Payouts/PayoutResponse.php b/lib/Request/Payouts/PayoutResponse.php index 938bc055..6f155ef9 100644 --- a/lib/Request/Payouts/PayoutResponse.php +++ b/lib/Request/Payouts/PayoutResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Payouts; * @package YooKassa */ class PayoutResponse extends AbstractPayoutResponse -{} +{ +} diff --git a/lib/Request/Payouts/PayoutSelfEmployedInfo.php b/lib/Request/Payouts/PayoutSelfEmployedInfo.php new file mode 100644 index 00000000..54f786b8 --- /dev/null +++ b/lib/Request/Payouts/PayoutSelfEmployedInfo.php @@ -0,0 +1,84 @@ +_id; + } + + /** + * Устанавливает идентификатор самозанятого. + * + * @param string $id Идентификатор самозанятого в ЮKassa. + * + * @return $this + */ + public function setId($id) + { + if (!TypeCast::canCastToString($id)) { + throw new InvalidPropertyValueTypeException('Invalid PayoutSelfEmployedInfo id value type', 0, 'PayoutSelfEmployedInfo.id', $id); + } + $length = mb_strlen($id, 'utf-8'); + if ($length < SelfEmployedInterface::MIN_LENGTH_ID || $length > SelfEmployedInterface::MAX_LENGTH_ID) { + throw new InvalidPropertyValueException('Invalid PayoutSelfEmployedInfo id value', 0, 'PayoutSelfEmployedInfo.id', $id); + } + $this->_id = (string)$id; + + return $this; + } +} diff --git a/lib/Request/Payouts/SbpBanksResponse.php b/lib/Request/Payouts/SbpBanksResponse.php new file mode 100644 index 00000000..9e764547 --- /dev/null +++ b/lib/Request/Payouts/SbpBanksResponse.php @@ -0,0 +1,104 @@ +_items = array(); + foreach ($sourceArray['items'] as $paymentInfo) { + $this->_items[] = new SbpParticipantBank($paymentInfo); + } + } + + /** + * Возвращает type. + * + * @return string + */ + public function getType() + { + return $this->_type; + } + + /** + * Устанавливает type. + * + * @param string $type Формат выдачи результатов запроса. Возможное значение: `list` (список). + * + * @return $this + */ + public function setType($type) + { + $this->_type = $type; + + return $this; + } + + /** + * Возвращает items. + * + * @return SbpParticipantBank[]|array + */ + public function getItems() + { + return $this->_items; + } +} diff --git a/lib/Request/PersonalData/CreatePersonalDataRequest.php b/lib/Request/PersonalData/CreatePersonalDataRequest.php new file mode 100644 index 00000000..30a311a9 --- /dev/null +++ b/lib/Request/PersonalData/CreatePersonalDataRequest.php @@ -0,0 +1,378 @@ +_type; + } + + /** + * Устанавливает тип персональных данных. + * + * @param string $type Тип персональных данных + * + * @return $this + */ + public function setType($type) + { + if (!TypeCast::canCastToEnumString($type)) { + throw new InvalidPropertyValueTypeException( + 'Invalid PersonalData type value type', + 0, + 'SbpPayoutRecipientPersonalDataRequest.type', + $type + ); + } + if (!PersonalDataType::valueExists((string)$type)) { + throw new InvalidPropertyValueException('Invalid PersonalData type value', 0, 'SbpPayoutRecipientPersonalDataRequest.type', $type); + } + $this->_type = (string)$type; + + return $this; + } + + /** + * Проверяет наличие типа персональных данных в запросе + * @return bool True если тип персональных данных задан, false если нет + */ + public function hasType() + { + return !empty($this->_type); + } + + /** + * Возвращает фамилию пользователя. + * + * @return string Фамилия пользователя + */ + public function getLastName() + { + return $this->_last_name; + } + + /** + * Устанавливает фамилию пользователя. + * + * @param string $last_name Фамилия пользователя. + * + * @return $this + */ + public function setLastName($last_name) + { + if ($last_name === null || $last_name === '') { + throw new InvalidPropertyValueException( + 'The value of the description parameter is empty', + 0, + 'SbpPayoutRecipientPersonalDataRequest.last_name', + $last_name + ); + } + if (!TypeCast::canCastToString($last_name)) { + throw new InvalidPropertyValueTypeException( + 'Invalid last_name value type', + 0, + 'SbpPayoutRecipientPersonalDataRequest.last_name', + $last_name + ); + } + $length = mb_strlen((string)$last_name, 'utf-8'); + if ($length > self::MAX_LENGTH_LAST_NAME) { + throw new InvalidPropertyValueException( + 'The value of the last_name parameter is too long. Max length is ' . self::MAX_LENGTH_LAST_NAME, + 0, + 'SbpPayoutRecipientPersonalDataRequest.last_name', + $last_name + ); + } + $this->_last_name = (string)$last_name; + + return $this; + } + + /** + * Проверяет наличие фамилии пользователя в запросе + * @return bool True если фамилия пользователя задана, false если нет + */ + public function hasLastName() + { + return !empty($this->_last_name); + } + + /** + * Возвращает имя пользователя. + * + * @return string Имя пользователя + */ + public function getFirstName() + { + return $this->_first_name; + } + + /** + * Устанавливает имя пользователя. + * + * @param string $first_name Имя пользователя. + * + * @return $this + */ + public function setFirstName($first_name) + { + if ($first_name === null || $first_name === '') { + throw new InvalidPropertyValueException( + 'The value of the description parameter is empty', + 0, + 'SbpPayoutRecipientPersonalDataRequest.first_name', + $first_name + ); + } + if (!TypeCast::canCastToString($first_name)) { + throw new InvalidPropertyValueTypeException( + 'Invalid first_name value type', + 0, + 'SbpPayoutRecipientPersonalDataRequest.first_name', + $first_name + ); + } + $length = mb_strlen((string)$first_name, 'utf-8'); + if ($length > self::MAX_LENGTH_FIRST_NAME) { + throw new InvalidPropertyValueException( + 'The value of the first_name parameter is too long. Max length is ' . self::MAX_LENGTH_FIRST_NAME, + 0, + 'SbpPayoutRecipientPersonalDataRequest.first_name', + $first_name + ); + } + $this->_first_name = (string)$first_name; + + return $this; + } + + /** + * Проверяет наличие имени пользователя в запросе + * @return bool True если имя пользователя задано, false если нет + */ + public function hasFirstName() + { + return !empty($this->_first_name); + } + + /** + * Возвращает отчество пользователя. + * + * @return string|null Отчество пользователя + */ + public function getMiddleName() + { + return $this->_middle_name; + } + + /** + * Устанавливает отчество пользователя. + * + * @param string|null $middle_name Отчество пользователя + * + * @return $this + */ + public function setMiddleName($middle_name = null) + { + if ($middle_name === null || $middle_name === '') { + $this->_middle_name = null; + return $this; + } + if (!TypeCast::canCastToString($middle_name)) { + throw new InvalidPropertyValueTypeException( + 'Invalid middle_name value type', + 0, + 'SbpPayoutRecipientPersonalDataRequest.middle_name', + $middle_name + ); + } + $length = mb_strlen((string)$middle_name, 'utf-8'); + if ($length > self::MAX_LENGTH_LAST_NAME) { + throw new InvalidPropertyValueException( + 'The value of the middle_name parameter is too long. Max length is ' . self::MAX_LENGTH_LAST_NAME, + 0, + 'SbpPayoutRecipientPersonalDataRequest.middle_name', + $middle_name + ); + } + $this->_middle_name = (string)$middle_name; + + return $this; + } + + /** + * Проверяет наличие отчества пользователя в запросе + * @return bool True если отчество пользователя задано, false если нет + */ + public function hasMiddleName() + { + return !empty($this->_middle_name); + } + + /** + * Возвращает метаданные. + * + * @return Metadata Метаданные + */ + public function getMetadata() + { + return $this->_metadata; + } + + /** + * Устанавливает метаданные. + * + * @param Metadata|array|null $metadata Метаданные + * + * @return $this + */ + public function setMetadata($metadata = null) + { + if ($metadata === null || (is_array($metadata) && empty($metadata))) { + $this->_metadata = null; + } elseif ($metadata instanceof Metadata) { + $this->_metadata = $metadata; + } elseif (is_array($metadata)) { + $this->_metadata = new Metadata($metadata); + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid metadata value type', + 0, + 'SbpPayoutRecipientPersonalDataRequest.metadata', + $metadata + ); + } + + return $this; + } + + /** + * Проверяет, были ли установлены метаданные + * @return bool True если метаданные были установлены, false если нет + */ + public function hasMetadata() + { + return !empty($this->_metadata) && $this->_metadata->count() > 0; + } + + /** + * Проверяет на валидность текущий объект + * @return bool True если объект запроса валиден, false если нет + */ + public function validate() + { + if (!$this->hasType()) { + $this->setValidationError('PersonalData type not specified'); + return false; + } + if (!$this->hasLastName()) { + $this->setValidationError('PersonalData last_name not specified'); + return false; + } + if (!$this->hasFirstName()) { + $this->setValidationError('PersonalData first_name not specified'); + return false; + } + + return true; + } + + /** + * Возвращает билдер объектов запросов создания платежа + * @return CreatePersonalDataRequestBuilder Инстанс билдера объектов запросов + */ + public static function builder() + { + return new CreatePersonalDataRequestBuilder(); + } +} diff --git a/lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php b/lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php new file mode 100644 index 00000000..e467b910 --- /dev/null +++ b/lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php @@ -0,0 +1,145 @@ +currentObject->setType($value); + + return $this; + } + + /** + * Устанавливает фамилию пользователя. + * + * @param string $value Фамилия пользователя. + * + * @return self + */ + public function setLastName($value) + { + $this->currentObject->setLastName($value); + + return $this; + } + + /** + * Устанавливает имя пользователя. + * + * @param string $value Имя пользователя. + * + * @return self + */ + public function setFirstName($value) + { + $this->currentObject->setFirstName($value); + + return $this; + } + + /** + * Устанавливает отчество пользователя. + * + * @param string $value Отчество пользователя. + * + * @return self + */ + public function setMiddleName($value) + { + $this->currentObject->setMiddleName($value); + + return $this; + } + + /** + * Устанавливает метаданные, привязанные к платежу + * @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом + * @return CreatePersonalDataRequestBuilder Инстанс текущего билдера + * + * @throws InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как + * метаданные платежа + */ + public function setMetadata($value) + { + $this->currentObject->setMetadata($value); + return $this; + } + + /** + * Строит и возвращает объект запроса для отправки в API ЮKassa + * @param array|null $options Массив параметров для установки в объект запроса + * @return CreatePersonalDataRequestInterface|CreatePersonalDataRequest|AbstractRequest Инстанс объекта запроса + * + * @throws InvalidRequestException Выбрасывается если собрать объект запроса не удалось + */ + public function build(array $options = null) + { + return parent::build($options); + } +} diff --git a/lib/Request/PersonalData/CreatePersonalDataRequestInterface.php b/lib/Request/PersonalData/CreatePersonalDataRequestInterface.php new file mode 100644 index 00000000..ff81dded --- /dev/null +++ b/lib/Request/PersonalData/CreatePersonalDataRequestInterface.php @@ -0,0 +1,160 @@ +hasType()) { + $result['type'] = $request->getType(); + } + if ($request->hasLastName()) { + $result['last_name'] = $request->getLastName(); + } + if ($request->hasFirstName()) { + $result['first_name'] = $request->getFirstName(); + } + if ($request->hasMiddleName()) { + $result['first_name'] = $request->getMiddleName(); + } + if ($request->hasMetadata()) { + $result['metadata'] = $request->getMetadata()->toArray(); + } + + return $result; + } +} diff --git a/lib/Request/PersonalData/PersonalDataResponse.php b/lib/Request/PersonalData/PersonalDataResponse.php new file mode 100644 index 00000000..da452acc --- /dev/null +++ b/lib/Request/PersonalData/PersonalDataResponse.php @@ -0,0 +1,42 @@ +_type = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid receipt type value type', 0, 'Receipt.type', $value + 'Invalid receipt type value type', + 0, + 'Receipt.type', + $value ); } } @@ -273,12 +276,18 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt $this->_status = (string)$value; } else { throw new InvalidPropertyValueException( - 'Invalid status value', 0, 'Receipt.status', $value + 'Invalid status value', + 0, + 'Receipt.status', + $value ); } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type', 0, 'Receipt.status', $value + 'Invalid status value type', + 0, + 'Receipt.status', + $value ); } return $this; @@ -305,7 +314,10 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt $this->_fiscalDocumentNumber = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid fiscal_document_number value type', 0, 'Receipt.fiscalDocumentNumber', $value + 'Invalid fiscal_document_number value type', + 0, + 'Receipt.fiscalDocumentNumber', + $value ); } else { $this->_fiscalDocumentNumber = (string)$value; @@ -414,7 +426,10 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid items value type in receipt', 0, 'receipt.items', $value + 'Invalid items value type in receipt', + 0, + 'receipt.items', + $value ); } $this->_items = array(); @@ -425,7 +440,10 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt $this->addItem($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid item value type in receipt', 0, 'receipt.items[' . $key . ']', $val + 'Invalid item value type in receipt', + 0, + 'receipt.items[' . $key . ']', + $val ); } } @@ -463,7 +481,10 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in receipt', 0, 'receipt.settlements', $value + 'Invalid settlements value type in receipt', + 0, + 'receipt.settlements', + $value ); } $this->_settlements = array(); @@ -474,7 +495,10 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlement value type in receipt', 0, 'receipt.settlements['.$key.']', $val + 'Invalid settlement value type in receipt', + 0, + 'receipt.settlements[' . $key . ']', + $val ); } } @@ -515,13 +539,17 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt $this->_taxSystemCode = null; } elseif (!is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid tax_system_code value type', 0, 'receipt.taxSystemCode' + 'Invalid tax_system_code value type', + 0, + 'receipt.taxSystemCode' ); } else { $castedValue = (int)$value; if ($castedValue < 1 || $castedValue > 6) { throw new InvalidPropertyValueException( - 'Invalid tax_system_code value: ' . $value, 0, 'receipt.taxSystemCode' + 'Invalid tax_system_code value: ' . $value, + 0, + 'receipt.taxSystemCode' ); } $this->_taxSystemCode = $castedValue; @@ -631,11 +659,16 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty onBehalfOf value', 0, 'Receipt.onBehalfOf' + 'Empty onBehalfOf value', + 0, + 'Receipt.onBehalfOf' ); } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid onBehalfOf value type', 0, 'Receipt.onBehalfOf', $value + 'Invalid onBehalfOf value type', + 0, + 'Receipt.onBehalfOf', + $value ); } else { $this->_onBehalfOf = (string)$value; diff --git a/lib/Request/Receipts/CreatePostReceiptRequest.php b/lib/Request/Receipts/CreatePostReceiptRequest.php index ea968620..d906ad2f 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequest.php +++ b/lib/Request/Receipts/CreatePostReceiptRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Request\Receipts; - use YooKassa\Common\AbstractRequest; use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; @@ -73,7 +72,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece /** @var OperationalDetails Операционный реквизит чека */ private $_receiptOperationalDetails; - /** @var ReceiptItemInterface[] Список товаров в заказе */ + /** @var ReceiptItemInterface[] Список товаров в заказе. Для чеков по 54-ФЗ можно передать не более 100 товаров, для чеков самозанятых — не более шести. */ private $_items = array(); /** @var SettlementInterface[] Список платежей */ @@ -111,10 +110,12 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает Id объекта чека * * @param string $value Id объекта чека + * @return CreatePostReceiptRequest */ public function setObjectId($value) { $this->_object_id = $value; + return $this; } /** @@ -131,10 +132,12 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает тип объекта чека * * @param string $value Тип объекта чека + * @return CreatePostReceiptRequest */ public function setObjectType($value) { $this->_object_type = $value; + return $this; } /** @@ -161,6 +164,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает информацию о плательщике * * @param ReceiptCustomerInterface|array $value Информация о плательщике + * @return CreatePostReceiptRequest */ public function setCustomer($value) { @@ -170,9 +174,13 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece $this->_customer = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid customer value type in receipt', 0, 'Receipt.customer', $value + 'Invalid customer value type in receipt', + 0, + 'Receipt.customer', + $value ); } + return $this; } /** @@ -206,7 +214,10 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid items value type in receipt', 0, 'Receipt.items', $value + 'Invalid items value type in receipt', + 0, + 'Receipt.items', + $value ); } $this->_items = array(); @@ -217,7 +228,10 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece $this->addItem($item); } else { throw new InvalidPropertyValueTypeException( - 'Invalid item value type in receipt', 0, 'Receipt.items['.$key.']', $item + 'Invalid item value type in receipt', + 0, + 'Receipt.items[' . $key . ']', + $item ); } } @@ -260,19 +274,26 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece { if ($value === null || $value === '') { throw new EmptyPropertyValueException('Empty taxSystemCode value in receipt', 0, 'Receipt.taxSystemCode'); - } elseif (!is_numeric($value)) { - throw new InvalidPropertyValueTypeException( - 'Invalid taxSystemCode value type', 0, 'Receipt.taxSystemCode' - ); - } else { - $castedValue = (int)$value; - if ($castedValue < 1 || $castedValue > 6) { - throw new InvalidPropertyValueException( - 'Invalid taxSystemCode value: '.$value, 0, 'Receipt.taxSystemCode' - ); - } - $this->_taxSystemCode = $castedValue; } + if (!is_numeric($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid taxSystemCode value type', + 0, + 'Receipt.taxSystemCode' + ); + } + + $castedValue = (int)$value; + if ($castedValue < 1 || $castedValue > 6) { + throw new InvalidPropertyValueException( + 'Invalid taxSystemCode value: ' . $value, + 0, + 'Receipt.taxSystemCode' + ); + } + $this->_taxSystemCode = $castedValue; + + return $this; } /** @@ -289,6 +310,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает дополнительный реквизит пользователя * * @param AdditionalUserProps|array $value Дополнительный реквизит пользователя + * @return void|CreatePostReceiptRequest */ public function setAdditionalUserProps($value) { @@ -302,9 +324,13 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece $this->_additionalUserProps = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid additionalUserProps value type in receipt', 0, 'Receipt.additional_user_props', $value + 'Invalid additionalUserProps value type in receipt', + 0, + 'Receipt.additional_user_props', + $value ); } + return $this; } /** @@ -318,15 +344,15 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece /** * Устанавливает отраслевой реквизит чека - * @param array|IndustryDetails[] $value Отраслевой реквизит чека + * @param array|IndustryDetails $value Отраслевой реквизит чека * - * @throws InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не массив + * @return CreatePostReceiptRequest */ public function setReceiptIndustryDetails($value) { if (empty($value)) { $this->_receiptIndustryDetails = null; - return; + return $this; } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( @@ -353,6 +379,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } } $this->_receiptIndustryDetails = $details; + return $this; } /** @@ -368,13 +395,13 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает операционный реквизит чека * @param array|OperationalDetails $value Операционный реквизит чека * - * @throws InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не массив + * @return CreatePostReceiptRequest */ public function setReceiptOperationalDetails($value) { if (empty($value)) { $this->_receiptOperationalDetails = null; - return; + return $this; } if (!is_array($value) && !($value instanceof OperationalDetails)) { throw new InvalidPropertyValueTypeException( @@ -390,6 +417,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } $this->_receiptOperationalDetails = $value; + return $this; } /** @@ -406,6 +434,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Устанавливает тип чека в онлайн-кассе * * @param string $value Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + * @return CreatePostReceiptRequest */ public function setType($value) { @@ -419,9 +448,13 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } } else { throw new InvalidPropertyValueTypeException( - 'Invalid receipt type value type', 0, 'Receipt.type', $value + 'Invalid receipt type value type', + 0, + 'Receipt.type', + $value ); } + return $this; } /** @@ -437,16 +470,22 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece /** * Устанавливает признак отложенной отправки чека. * @param bool $value Признак отложенной отправки чека. + * @return CreatePostReceiptRequest */ public function setSend($value) { - if (TypeCast::canCastToBoolean($value)) { - $this->_send = (bool)$value; - } else { + if (!TypeCast::canCastToBoolean($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid receipt type value send', 0, 'Receipt.send', $value + 'Invalid receipt type value send', + 0, + 'Receipt.send', + $value ); } + + $this->_send = (bool)$value; + + return $this; } /** @@ -462,7 +501,8 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece /** * Устанавливает массив оплат, обеспечивающих выдачу товара. * - * @param SettlementInterface[]|array $value Массив оплат, обеспечивающих выдачу товара. + * @param SettlementInterface|array $value Массив оплат, обеспечивающих выдачу товара. + * @return CreatePostReceiptRequest */ public function setSettlements($value) { @@ -471,7 +511,10 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } if (!is_array($value) && !($value instanceof \Traversable)) { throw new InvalidPropertyValueTypeException( - 'Invalid settlements value type in receipt', 0, 'Receipt.settlements', $value + 'Invalid settlements value type in receipt', + 0, + 'Receipt.settlements', + $value ); } $this->_settlements = array(); @@ -482,10 +525,14 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece $this->addSettlement($val); } else { throw new InvalidPropertyValueTypeException( - 'Invalid settlement value type in receipt', 0, 'Receipt.settlements['.$key.']', $val + 'Invalid settlement value type in receipt', + 0, + 'Receipt.settlements[' . $key . ']', + $val ); } } + return $this; } /** @@ -516,20 +563,29 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * Необходимо передавать, если вы используете решение ЮKassa для платформ. * * @param string $value + * @return CreatePostReceiptRequest */ public function setOnBehalfOf($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty onBehalfOf value', 0, 'Receipt.onBehalfOf' + 'Empty onBehalfOf value', + 0, + 'Receipt.onBehalfOf' ); - } elseif (!TypeCast::canCastToString($value)) { - throw new InvalidPropertyValueTypeException( - 'Invalid onBehalfOf value type', 0, 'Receipt.onBehalfOf', $value - ); - } else { - $this->_onBehalfOf = (string)$value; } + if (!TypeCast::canCastToString($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid onBehalfOf value type', + 0, + 'Receipt.onBehalfOf', + $value + ); + } + + $this->_onBehalfOf = (string)$value; + + return $this; } /** diff --git a/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php b/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php index 749aa843..1693be73 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Request\Receipts; - use YooKassa\Common\AbstractPaymentRequestBuilder; use YooKassa\Common\AbstractRequest; use YooKassa\Common\AbstractRequestBuilder; diff --git a/lib/Request/Receipts/CreatePostReceiptRequestInterface.php b/lib/Request/Receipts/CreatePostReceiptRequestInterface.php index 9bd482d2..0f405e07 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestInterface.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -88,6 +88,21 @@ interface CreatePostReceiptRequestInterface */ public function setType($value); + /** + * Возвращает тип объекта чека + * + * @return string Тип объекта чека + */ + public function getObjectType(); + + /** + * Устанавливает тип объекта чека + * + * @param string $value Тип объекта чека + * @return CreatePostReceiptRequestInterface + */ + public function setObjectType($value); + /** * Возвращает признак отложенной отправки чека * diff --git a/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php b/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php index 04c07a48..46f613df 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -61,7 +61,7 @@ class CreatePostReceiptRequestSerializer } $customer = $request->getCustomer(); - if (!empty($customer)) { + if ($customer !== null) { $result['customer'] = $customer->jsonSerialize(); } diff --git a/lib/Request/Receipts/PaymentReceiptResponse.php b/lib/Request/Receipts/PaymentReceiptResponse.php index 7f4a7bfc..5121b37e 100644 --- a/lib/Request/Receipts/PaymentReceiptResponse.php +++ b/lib/Request/Receipts/PaymentReceiptResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -83,11 +83,13 @@ class PaymentReceiptResponse extends AbstractReceiptResponse throw new InvalidPropertyValueTypeException('Invalid payment_id value type', 0, 'Receipt.paymentId'); } elseif (mb_strlen((string)$value) !== self::LENGTH_PAYMENT_ID) { throw new InvalidPropertyValueException( - 'Invalid payment_id value: "'.$value.'"', 0, 'Receipt.paymentId', $value + 'Invalid payment_id value: "' . $value . '"', + 0, + 'Receipt.paymentId', + $value ); } else { $this->_payment_id = (string)$value; } } - } diff --git a/lib/Request/Receipts/ReceiptResponseFactory.php b/lib/Request/Receipts/ReceiptResponseFactory.php index 58464dfb..a86b544d 100644 --- a/lib/Request/Receipts/ReceiptResponseFactory.php +++ b/lib/Request/Receipts/ReceiptResponseFactory.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -26,7 +26,6 @@ namespace YooKassa\Request\Receipts; - use YooKassa\Model\ReceiptType; /** diff --git a/lib/Request/Receipts/ReceiptResponseInterface.php b/lib/Request/Receipts/ReceiptResponseInterface.php index 36e8f7bc..93b96dad 100644 --- a/lib/Request/Receipts/ReceiptResponseInterface.php +++ b/lib/Request/Receipts/ReceiptResponseInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Receipts/ReceiptResponseItem.php b/lib/Request/Receipts/ReceiptResponseItem.php index 327a1ebf..d154f05c 100644 --- a/lib/Request/Receipts/ReceiptResponseItem.php +++ b/lib/Request/Receipts/ReceiptResponseItem.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -220,19 +220,26 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty description value in ReceiptItem', 0, 'ReceiptItem.description' + 'Empty description value in ReceiptItem', + 0, + 'ReceiptItem.description' ); } elseif (TypeCast::canCastToString($value)) { $castedValue = (string)$value; if ($castedValue === '') { throw new EmptyPropertyValueException( - 'Empty description value in ReceiptItem', 0, 'ReceiptItem.description' + 'Empty description value in ReceiptItem', + 0, + 'ReceiptItem.description' ); } $this->_description = $castedValue; } else { throw new InvalidPropertyValueTypeException( - 'Empty description value in ReceiptItem', 0, 'ReceiptItem.description', $value + 'Empty description value in ReceiptItem', + 0, + 'ReceiptItem.description', + $value ); } } @@ -262,11 +269,17 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI throw new EmptyPropertyValueException('Empty quantity value in ReceiptItem', 0, 'ReceiptItem.quantity'); } elseif (!is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid quantity value type in ReceiptItem', 0, 'ReceiptItem.quantity', $value + 'Invalid quantity value type in ReceiptItem', + 0, + 'ReceiptItem.quantity', + $value ); } elseif ($value <= 0.0) { throw new InvalidPropertyValueException( - 'Invalid quantity value in ReceiptItem', 0, 'ReceiptItem.quantity', $value + 'Invalid quantity value in ReceiptItem', + 0, + 'ReceiptItem.quantity', + $value ); } else { $this->_quantity = (float)$value; @@ -325,11 +338,17 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI $this->_vatCode = null; } elseif (!is_numeric($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid vatId value type in ReceiptItem', 0, 'ReceiptItem.vatId', $value + 'Invalid vatId value type in ReceiptItem', + 0, + 'ReceiptItem.vatId', + $value ); } elseif ($value < 1 || $value > 6) { throw new InvalidPropertyValueException( - 'Invalid vatId value in ReceiptItem', 0, 'ReceiptItem.vatId', $value + 'Invalid vatId value in ReceiptItem', + 0, + 'ReceiptItem.vatId', + $value ); } else { $this->_vatCode = (int)$value; @@ -385,7 +404,10 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI $this->_paymentMode = null; } elseif (!TypeCast::canCastToString($value)) { throw new InvalidPropertyValueTypeException( - 'Invalid paymentMode value type', 0, 'ReceiptItem.paymentMode', $value + 'Invalid paymentMode value type', + 0, + 'ReceiptItem.paymentMode', + $value ); } else { $this->_paymentMode = $value; @@ -763,7 +785,9 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI { if ($value === null || $value === '') { throw new EmptyPropertyValueException( - 'Empty supplier value in receipt', 0, 'Receipt.supplier' + 'Empty supplier value in receipt', + 0, + 'Receipt.supplier' ); } @@ -773,7 +797,10 @@ class ReceiptResponseItem extends AbstractObject implements ReceiptResponseItemI if (!($value instanceof SupplierInterface)) { throw new InvalidPropertyValueTypeException( - 'Invalid supplier value type in receipt', 0, 'Receipt.supplier', $value + 'Invalid supplier value type in receipt', + 0, + 'Receipt.supplier', + $value ); } diff --git a/lib/Request/Receipts/ReceiptResponseItemInterface.php b/lib/Request/Receipts/ReceiptResponseItemInterface.php index e0420843..dc8af777 100644 --- a/lib/Request/Receipts/ReceiptResponseItemInterface.php +++ b/lib/Request/Receipts/ReceiptResponseItemInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -82,7 +82,7 @@ interface ReceiptResponseItemInterface /** * Возвращает общую стоимость покупаемого товара в копейках/центах - * @return float Сумма стоимости покупаемого товара + * @return int Сумма стоимости покупаемого товара */ public function getAmount(); diff --git a/lib/Request/Receipts/ReceiptsRequest.php b/lib/Request/Receipts/ReceiptsRequest.php index 19905674..3cc4928a 100644 --- a/lib/Request/Receipts/ReceiptsRequest.php +++ b/lib/Request/Receipts/ReceiptsRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -128,13 +128,19 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $length = mb_strlen((string)$value, 'utf-8'); if ($length != 36) { throw new InvalidPropertyValueException( - 'Invalid payment id value in ReceiptsRequest', 0, 'ReceiptsRequest.refundId', $value + 'Invalid payment id value in ReceiptsRequest', + 0, + 'ReceiptsRequest.refundId', + $value ); } $this->_refundId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment id value type in ReceiptsRequest', 0, 'ReceiptsRequest.refundId', $value + 'Invalid payment id value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.refundId', + $value ); } } @@ -172,13 +178,19 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $length = mb_strlen((string)$value, 'utf-8'); if ($length != 36) { throw new InvalidPropertyValueException( - 'Invalid payment id value in ReceiptsRequest', 0, 'ReceiptsRequest.paymentId', $value + 'Invalid payment id value in ReceiptsRequest', + 0, + 'ReceiptsRequest.paymentId', + $value ); } $this->_paymentId = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid payment id value type in ReceiptsRequest', 0, 'ReceiptsRequest.paymentId', $value + 'Invalid payment id value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.paymentId', + $value ); } } @@ -218,13 +230,17 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_gte value in ReceiptsRequest', 0, 'ReceiptsRequest.createdAtGte' + 'Invalid created_gte value in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdAtGte' ); } $this->_createdAtGte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid created_gte value type in ReceiptsRequest', 0, 'ReceiptsRequest.createdAtGte' + 'Invalid created_gte value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdAtGte' ); } } @@ -264,13 +280,17 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_gt value in ReceiptsRequest', 0, 'ReceiptsRequest.createdAtGt' + 'Invalid created_gt value in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdAtGt' ); } $this->_createdAtGt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid created_gt value type in ReceiptsRequest', 0, 'ReceiptsRequest.createdAtGt' + 'Invalid created_gt value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdAtGt' ); } } @@ -310,13 +330,17 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_lte value in ReceiptsRequest', 0, 'ReceiptsRequest.createdLte' + 'Invalid created_lte value in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdLte' ); } $this->_createdAtLte = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid created_lte value type in ReceiptsRequest', 0, 'ReceiptsRequest.createdLte' + 'Invalid created_lte value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdLte' ); } } @@ -356,13 +380,17 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_lt value in ReceiptsRequest', 0, 'ReceiptsRequest.createdLt' + 'Invalid created_lt value in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdLt' ); } $this->_createdAtLt = $dateTime; } else { throw new InvalidPropertyValueTypeException( - 'Invalid created_lt value type in ReceiptsRequest', 0, 'ReceiptsRequest.createdLt' + 'Invalid created_lt value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.createdLt' ); } } @@ -399,14 +427,20 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac } elseif (TypeCast::canCastToEnumString($value)) { if (!RefundStatus::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid status value in ReceiptsRequest', 0, 'ReceiptsRequest.status', $value + 'Invalid status value in ReceiptsRequest', + 0, + 'ReceiptsRequest.status', + $value ); } else { $this->_status = (string)$value; } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in ReceiptsRequest', 0, 'ReceiptsRequest.status', $value + 'Invalid status value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.status', + $value ); } } @@ -443,7 +477,10 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac $this->_cursor = (string) $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value type in ReceiptsRequest', 0, 'ReceiptsRequest.cursor', $value + 'Invalid status value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.cursor', + $value ); } } @@ -479,13 +516,19 @@ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterfac } elseif (is_int($value)) { if ($value < 0 || $value > self::MAX_LIMIT_VALUE) { throw new InvalidPropertyValueException( - 'Invalid limit value in ReceiptsRequest', 0, 'ReceiptsRequest.limit', $value + 'Invalid limit value in ReceiptsRequest', + 0, + 'ReceiptsRequest.limit', + $value ); } $this->_limit = $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid limit value type in ReceiptsRequest', 0, 'ReceiptsRequest.limit', $value + 'Invalid limit value type in ReceiptsRequest', + 0, + 'ReceiptsRequest.limit', + $value ); } } diff --git a/lib/Request/Receipts/ReceiptsRequestBuilder.php b/lib/Request/Receipts/ReceiptsRequestBuilder.php index c239469e..2833cba6 100644 --- a/lib/Request/Receipts/ReceiptsRequestBuilder.php +++ b/lib/Request/Receipts/ReceiptsRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Receipts/ReceiptsRequestInterface.php b/lib/Request/Receipts/ReceiptsRequestInterface.php index 4ce23d6e..0313f6f3 100644 --- a/lib/Request/Receipts/ReceiptsRequestInterface.php +++ b/lib/Request/Receipts/ReceiptsRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,107 +47,107 @@ interface ReceiptsRequestInterface * Возвращает идентификатор возврата * @return string Идентификатор возврата */ - function getRefundId(); + public function getRefundId(); /** * Проверяет, был ли установлен идентификатор возврата * @return bool True если идентификатор возврата был установлен, false если не был */ - function hasRefundId(); + public function hasRefundId(); /** * Возвращает идентификатор платежа если он задан или null * @return string|null Идентификатор платежа */ - function getPaymentId(); + public function getPaymentId(); /** * Проверяет, был ли задан идентификатор платежа * @return bool True если идентификатор был задан, false если нет */ - function hasPaymentId(); + public function hasPaymentId(); /** * Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, от (включительно) */ - function getCreatedAtGte(); + public function getCreatedAtGte(); /** * Проверяет, была ли установлена дата создания от которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGte(); + public function hasCreatedAtGte(); /** * Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, от (не включая) */ - function getCreatedAtGt(); + public function getCreatedAtGt(); /** * Проверяет, была ли установлена дата создания от которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGt(); + public function hasCreatedAtGt(); /** * Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, до (включительно) */ - function getCreatedAtLte(); + public function getCreatedAtLte(); /** * Проверяет, была ли установлена дата создания до которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLte(); + public function hasCreatedAtLte(); /** * Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, до (не включая) */ - function getCreatedAtLt(); + public function getCreatedAtLt(); /** * Проверяет, была ли установлена дата создания до которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLt(); + public function hasCreatedAtLt(); /** * Возвращает статус выбираемых возвратов или null, если он до этого не был установлен * @return string|null Статус выбираемых возвратов */ - function getStatus(); + public function getStatus(); /** * Проверяет, был ли установлен статус выбираемых возвратов * @return bool True если статус был установлен, false если нет */ - function hasStatus(); + public function hasStatus(); /** * Возвращает токен для получения следующей страницы выборки * @return string|null Токен для получения следующей страницы выборки */ - function getCursor(); + public function getCursor(); /** * Проверяет, был ли установлен токен следующей страницы * @return bool True если токен был установлен, false если нет */ - function hasCursor(); + public function hasCursor(); /** * Возвращает ограничение количества объектов или null, если оно до этого не было установлено * @return string|null Ограничение количества объектов */ - function getLimit(); + public function getLimit(); /** * Проверяет, было ли установлено ограничение количества объектов * @return bool True если ограничение количества объектов было установлено, false если нет */ - function hasLimit(); + public function hasLimit(); } diff --git a/lib/Request/Receipts/ReceiptsRequestSerializer.php b/lib/Request/Receipts/ReceiptsRequestSerializer.php index 4fe66e69..8b006ad6 100644 --- a/lib/Request/Receipts/ReceiptsRequestSerializer.php +++ b/lib/Request/Receipts/ReceiptsRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Receipts/ReceiptsResponse.php b/lib/Request/Receipts/ReceiptsResponse.php index 36be89f2..059ffb72 100644 --- a/lib/Request/Receipts/ReceiptsResponse.php +++ b/lib/Request/Receipts/ReceiptsResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Receipts/RefundReceiptResponse.php b/lib/Request/Receipts/RefundReceiptResponse.php index a1f10079..e8b86cd0 100644 --- a/lib/Request/Receipts/RefundReceiptResponse.php +++ b/lib/Request/Receipts/RefundReceiptResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -83,11 +83,13 @@ class RefundReceiptResponse extends AbstractReceiptResponse throw new InvalidPropertyValueTypeException('Invalid refund_id value type', 0, 'Receipt.refundId'); } elseif (mb_strlen((string)$value) !== self::LENGTH_REFUND_ID) { throw new InvalidPropertyValueException( - 'Invalid refund_id value: "'.$value.'"', 0, 'Receipt.refundId', $value + 'Invalid refund_id value: "' . $value . '"', + 0, + 'Receipt.refundId', + $value ); } else { $this->_refund_id = (string)$value; } } - } diff --git a/lib/Request/Receipts/SimpleReceiptResponse.php b/lib/Request/Receipts/SimpleReceiptResponse.php index 315f6dff..b85d9307 100644 --- a/lib/Request/Receipts/SimpleReceiptResponse.php +++ b/lib/Request/Receipts/SimpleReceiptResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -41,5 +41,6 @@ class SimpleReceiptResponse extends AbstractReceiptResponse * @return void */ public function setSpecificProperties($receiptData) - {} + { + } } diff --git a/lib/Request/Refunds/AbstractRefundResponse.php b/lib/Request/Refunds/AbstractRefundResponse.php index 85e6d37e..f11dce18 100644 --- a/lib/Request/Refunds/AbstractRefundResponse.php +++ b/lib/Request/Refunds/AbstractRefundResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Refunds/CreateRefundRequest.php b/lib/Request/Refunds/CreateRefundRequest.php index b47dd412..27d72dc7 100644 --- a/lib/Request/Refunds/CreateRefundRequest.php +++ b/lib/Request/Refunds/CreateRefundRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -49,7 +49,6 @@ use YooKassa\Model\SourceInterface; */ class CreateRefundRequest extends AbstractRefundRequest implements CreateRefundRequestInterface { - /** * @var string Комментарий к операции возврата, основание для возврата средств покупателю. */ @@ -97,7 +96,10 @@ class CreateRefundRequest extends AbstractRefundRequest implements CreateRefundR $this->_description = (string)$value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid description value type in CreateRefundRequest', 0, 'CreateRefundRequest.description', $value + 'Invalid description value type in CreateRefundRequest', + 0, + 'CreateRefundRequest.description', + $value ); } } @@ -198,7 +200,10 @@ class CreateRefundRequest extends AbstractRefundRequest implements CreateRefundR $this->_deal = new RefundDealData($value); } else { throw new InvalidPropertyValueTypeException( - 'Invalid deal value type in CreateRefundRequest', 0, 'CreateRefundRequest.deal', $value + 'Invalid deal value type in CreateRefundRequest', + 0, + 'CreateRefundRequest.deal', + $value ); } } diff --git a/lib/Request/Refunds/CreateRefundRequestBuilder.php b/lib/Request/Refunds/CreateRefundRequestBuilder.php index baa54c53..d99bd40f 100644 --- a/lib/Request/Refunds/CreateRefundRequestBuilder.php +++ b/lib/Request/Refunds/CreateRefundRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -43,7 +43,6 @@ use YooKassa\Model\SourceInterface; */ class CreateRefundRequestBuilder extends AbstractPaymentRequestBuilder { - /** * Собираемый объект запроса к API * @var CreateRefundRequest diff --git a/lib/Request/Refunds/CreateRefundRequestInterface.php b/lib/Request/Refunds/CreateRefundRequestInterface.php index faefce84..de4fca81 100644 --- a/lib/Request/Refunds/CreateRefundRequestInterface.php +++ b/lib/Request/Refunds/CreateRefundRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -47,89 +47,89 @@ interface CreateRefundRequestInterface * Возвращает айди платежа для которого создаётся возврат средств * @return string Айди платежа для которого создаётся возврат */ - function getPaymentId(); + public function getPaymentId(); /** * Возвращает сумму возвращаемых средств * @return AmountInterface Сумма возврата */ - function getAmount(); + public function getAmount(); /** * Проверяет, был ли установлена идентификатор платежа * @return bool True если идентификатор платежа был установлен, false если нет */ - function hasPaymentId(); + public function hasPaymentId(); /** * Устанавливает комментарий к возврату * @param string $value Комментарий к операции возврата, основание для возврата средств покупателю */ - function setDescription($value); + public function setDescription($value); /** * Возвращает комментарий к возврату или null, если комментарий не задан * @return string Комментарий к операции возврата, основание для возврата средств покупателю. */ - function getDescription(); + public function getDescription(); /** * Проверяет задан ли комментарий к создаваемому возврату * @return bool True если комментарий установлен, false если нет */ - function hasDescription(); + public function hasDescription(); /** * Устанавливает чек * @param ReceiptInterface|null $value Инстанс чека или null для удаления информации о чеке */ - function setReceipt($value); + public function setReceipt($value); /** * Возвращает инстанс чека или null, если чек не задан * @return ReceiptInterface|null Инстанс чека или null */ - function getReceipt(); + public function getReceipt(); /** * Проверяет задан ли чек * @return bool True если чек есть, false если нет */ - function hasReceipt(); + public function hasReceipt(); /** * Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести * @param SourceInterface[] $value Информация о распределении денег */ - function setSources($value); + public function setSources($value); /** * Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести * @return SourceInterface[] Информация о распределении денег */ - function getSources(); + public function getSources(); /** * Проверяет наличие информации о распределении денег * @return bool */ - function hasSources(); + public function hasSources(); /** * Устанавливает информацию о сделке * @param RefundDealData $value Информация о сделке */ - function setDeal($value); + public function setDeal($value); /** * Возвращает информацию о сделке * @return RefundDealData Информация о сделке */ - function getDeal(); + public function getDeal(); /** * Проверяет наличие информации о сделке * @return bool */ - function hasDeal(); + public function hasDeal(); } diff --git a/lib/Request/Refunds/CreateRefundRequestSerializer.php b/lib/Request/Refunds/CreateRefundRequestSerializer.php index ed2e6608..519fb24d 100644 --- a/lib/Request/Refunds/CreateRefundRequestSerializer.php +++ b/lib/Request/Refunds/CreateRefundRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Refunds/CreateRefundResponse.php b/lib/Request/Refunds/CreateRefundResponse.php index 90323964..1834c979 100644 --- a/lib/Request/Refunds/CreateRefundResponse.php +++ b/lib/Request/Refunds/CreateRefundResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Refunds; * @package YooKassa */ class CreateRefundResponse extends AbstractRefundResponse -{} +{ +} diff --git a/lib/Request/Refunds/RefundResponse.php b/lib/Request/Refunds/RefundResponse.php index 70b7494a..59862a5c 100644 --- a/lib/Request/Refunds/RefundResponse.php +++ b/lib/Request/Refunds/RefundResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -32,4 +32,5 @@ namespace YooKassa\Request\Refunds; * @package YooKassa */ class RefundResponse extends AbstractRefundResponse -{} +{ +} diff --git a/lib/Request/Refunds/RefundsRequest.php b/lib/Request/Refunds/RefundsRequest.php index 38d958aa..b336f2a2 100644 --- a/lib/Request/Refunds/RefundsRequest.php +++ b/lib/Request/Refunds/RefundsRequest.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -125,13 +125,19 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $length = mb_strlen((string)$value, 'utf-8'); if ($length != 36) { throw new InvalidPropertyValueException( - 'Invalid payment id value in RefundsRequest', 0, 'RefundsRequest.paymentId', $value + '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 + 'Invalid payment id value type in RefundsRequest', + 0, + 'RefundsRequest.paymentId', + $value ); } } @@ -171,13 +177,17 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_gte value in RefundsRequest', 0, 'RefundsRequest.createdAtGte' + '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' + 'Invalid created_gte value type in RefundsRequest', + 0, + 'RefundsRequest.createdAtGte' ); } } @@ -217,13 +227,17 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_gt value in RefundsRequest', 0, 'RefundsRequest.createdAtGt' + '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' + 'Invalid created_gt value type in RefundsRequest', + 0, + 'RefundsRequest.createdAtGt' ); } } @@ -263,13 +277,17 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_lte value in RefundsRequest', 0, 'RefundsRequest.createdLte' + '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' + 'Invalid created_lte value type in RefundsRequest', + 0, + 'RefundsRequest.createdLte' ); } } @@ -309,13 +327,17 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $dateTime = TypeCast::castToDateTime($value); if ($dateTime === null) { throw new InvalidPropertyValueException( - 'Invalid created_lt value in RefundsRequest', 0, 'RefundsRequest.createdLt' + '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' + 'Invalid created_lt value type in RefundsRequest', + 0, + 'RefundsRequest.createdLt' ); } } @@ -352,14 +374,20 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface } elseif (TypeCast::canCastToEnumString($value)) { if (!RefundStatus::valueExists((string)$value)) { throw new InvalidPropertyValueException( - 'Invalid status value in RefundsRequest', 0, 'RefundsRequest.status', $value + 'Invalid status value in RefundsRequest', + 0, + 'RefundsRequest.status', + $value ); } else { $this->_status = (string)$value; } } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value in RefundsRequest', 0, 'RefundsRequest.status', $value + 'Invalid status value in RefundsRequest', + 0, + 'RefundsRequest.status', + $value ); } } @@ -396,7 +424,10 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface $this->_cursor = (string) $value; } else { throw new InvalidPropertyValueTypeException( - 'Invalid status value in RefundsRequest', 0, 'RefundsRequest.cursor', $value + 'Invalid status value in RefundsRequest', + 0, + 'RefundsRequest.cursor', + $value ); } } @@ -432,13 +463,19 @@ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface } elseif (is_int($value)) { if ($value < 0 || $value > self::MAX_LIMIT_VALUE) { throw new InvalidPropertyValueException( - 'Invalid limit value in RefundsRequest', 0, 'RefundsRequest.limit', $value + '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 + 'Invalid limit value type in RefundsRequest', + 0, + 'RefundsRequest.limit', + $value ); } } diff --git a/lib/Request/Refunds/RefundsRequestBuilder.php b/lib/Request/Refunds/RefundsRequestBuilder.php index 6297456f..758235ab 100644 --- a/lib/Request/Refunds/RefundsRequestBuilder.php +++ b/lib/Request/Refunds/RefundsRequestBuilder.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Refunds/RefundsRequestInterface.php b/lib/Request/Refunds/RefundsRequestInterface.php index 00dbdcaf..8ee8fd2b 100644 --- a/lib/Request/Refunds/RefundsRequestInterface.php +++ b/lib/Request/Refunds/RefundsRequestInterface.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -46,83 +46,83 @@ interface RefundsRequestInterface * Возвращает идентификатор платежа если он задан или null * @return string|null Идентификатор платежа */ - function getPaymentId(); + public function getPaymentId(); /** * Проверяет, был ли задан идентификатор платежа * @return bool True если идентификатор был задан, false если нет */ - function hasPaymentId(); + public function hasPaymentId(); /** * Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, от (включительно) */ - function getCreatedAtGte(); + public function getCreatedAtGte(); /** * Проверяет, была ли установлена дата создания от которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGte(); + public function hasCreatedAtGte(); /** * Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, от (не включая) */ - function getCreatedAtGt(); + public function getCreatedAtGt(); /** * Проверяет, была ли установлена дата создания от которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtGt(); + public function hasCreatedAtGt(); /** * Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, до (включительно) */ - function getCreatedAtLte(); + public function getCreatedAtLte(); /** * Проверяет, была ли установлена дата создания до которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLte(); + public function hasCreatedAtLte(); /** * Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена * @return \DateTime|null Время создания, до (не включая) */ - function getCreatedAtLt(); + public function getCreatedAtLt(); /** * Проверяет, была ли установлена дата создания до которой выбираются возвраты * @return bool True если дата была установлена, false если нет */ - function hasCreatedAtLt(); + public function hasCreatedAtLt(); /** * Возвращает статус выбираемых возвратов или null, если он до этого не был установлен * @return string|null Статус выбираемых возвратов */ - function getStatus(); + public function getStatus(); /** * Проверяет, был ли установлен статус выбираемых возвратов * @return bool True если статус был установлен, false если нет */ - function hasStatus(); + public function hasStatus(); /** * Возвращает токен для получения следующей страницы выборки * @return string|null Токен для получения следующей страницы выборки */ - function getCursor(); + public function getCursor(); /** * Проверяет, был ли установлен токен следующей страницы * @return bool True если токен был установлен, false если нет */ - function hasCursor(); + public function hasCursor(); } diff --git a/lib/Request/Refunds/RefundsRequestSerializer.php b/lib/Request/Refunds/RefundsRequestSerializer.php index 972a77b1..d5c61524 100644 --- a/lib/Request/Refunds/RefundsRequestSerializer.php +++ b/lib/Request/Refunds/RefundsRequestSerializer.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 diff --git a/lib/Request/Refunds/RefundsResponse.php b/lib/Request/Refunds/RefundsResponse.php index 63bc95f3..be7e257d 100644 --- a/lib/Request/Refunds/RefundsResponse.php +++ b/lib/Request/Refunds/RefundsResponse.php @@ -3,7 +3,7 @@ /** * The MIT License * - * Copyright (c) 2022 "YooMoney", NBСO LLC + * 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 @@ -88,5 +88,4 @@ class RefundsResponse { return $this->nextCursor !== null; } - } diff --git a/lib/Request/SelfEmployed/SelfEmployedRequest.php b/lib/Request/SelfEmployed/SelfEmployedRequest.php new file mode 100644 index 00000000..59a5b191 --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequest.php @@ -0,0 +1,209 @@ +_itn; + } + + /** + * Устанавливает ИНН самозанятого + * + * @param string|null $itn ИНН самозанятого + * + * @return $this + */ + public function setItn($itn = null) + { + if ($itn === null || $itn === '') { + $this->_itn = null; + } elseif (!TypeCast::canCastToString($itn)) { + throw new InvalidPropertyValueTypeException('Invalid itn value type', 0, 'SelfEmployed.itn'); + } else { + $this->_itn = (string)preg_replace('/\D/', '', $itn); + } + + return $this; + } + + /** + * Проверяет наличие ИНН самозанятого в запросе + * @return bool True если ИНН самозанятого задан, false если нет + */ + public function hasItn() + { + return !empty($this->_itn); + } + + /** + * Возвращает телефон самозанятого. + * + * @return string|null Телефон самозанятого + */ + public function getPhone() + { + return $this->_phone; + } + + /** + * Устанавливает телефон самозанятого. + * + * @param string|null $phone Телефон самозанятого + * + * @return $this + */ + public function setPhone($phone = null) + { + if ($phone === null || $phone === '') { + $this->_phone = null; + } elseif (!TypeCast::canCastToString($phone)) { + throw new InvalidPropertyValueTypeException('Invalid phone value type', 0, 'SelfEmployedRequest.phone'); + } else { + $this->_phone = (string)preg_replace('/\D/', '', $phone); + } + + return $this; + } + + /** + * Проверяет наличие телефона самозанятого в запросе + * @return bool True если телефон самозанятого задан, false если нет + */ + public function hasPhone() + { + return !empty($this->_phone); + } + + /** + * Возвращает сценарий подтверждения. + * + * @return SelfEmployedRequestConfirmation|null Сценарий подтверждения + */ + public function getConfirmation() + { + return $this->_confirmation; + } + + /** + * Устанавливает сценарий подтверждения. + * + * @param SelfEmployedConfirmation|array|null $confirmation Сценарий подтверждения + * + * @return $this + */ + public function setConfirmation($confirmation = null) + { + if ($confirmation === null || $confirmation === '') { + $this->_confirmation = null; + } elseif (is_array($confirmation)) { + $factory = new SelfEmployedRequestConfirmationFactory(); + $this->_confirmation = $factory->factoryFromArray($confirmation); + } elseif ($confirmation instanceof SelfEmployedRequestConfirmation) { + $this->_confirmation = $confirmation; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "confirmation" parameter in SelfEmployedRequest', + 0, + 'SelfEmployedRequest.confirmation', + $confirmation + ); + } + + return $this; + } + + /** + * Проверяет наличие сценария подтверждения самозанятого в запросе + * @return bool True если сценарий подтверждения самозанятого задан, false если нет + */ + public function hasConfirmation() + { + return !empty($this->_confirmation); + } + + /** + * Проверяет на валидность текущий объект + * @return bool True если объект запроса валиден, false если нет + */ + public function validate() + { + if (!$this->hasPhone() && !$this->hasItn()) { + $this->setValidationError('Both itn and phone values are empty in SelfEmployedRequest'); + return false; + } + + return true; + } + + /** + * Возвращает билдер объектов запросов создания платежа + * @return SelfEmployedRequestBuilder Инстанс билдера объектов запросов + */ + public static function builder() + { + return new SelfEmployedRequestBuilder(); + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php b/lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php new file mode 100644 index 00000000..2c5cef8a --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequestBuilder.php @@ -0,0 +1,111 @@ +currentObject->setItn($value); + + return $this; + } + + /** + * Устанавливает телефон самозанятого. + * + * @param string|null $value Телефон самозанятого. + * + * @return self Инстанс билдера запросов + */ + public function setPhone($value) + { + $this->currentObject->setPhone($value); + + return $this; + } + + /** + * Устанавливает сценарий подтверждения. + * + * @param SelfEmployedConfirmation|array|null $value Сценарий подтверждения. + * + * @return self Инстанс билдера запросов + */ + public function setConfirmation($value) + { + $this->currentObject->setConfirmation($value); + + return $this; + } + + /** + * Строит и возвращает объект запроса для отправки в API ЮKassa + * @param array|null $options Массив параметров для установки в объект запроса + * @return SelfEmployedRequest|AbstractRequest Инстанс объекта запроса + * + * @throws InvalidRequestException Выбрасывается если собрать объект запроса не удалось + */ + public function build(array $options = null) + { + return parent::build($options); + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedRequestConfirmation.php b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmation.php new file mode 100644 index 00000000..7c25d397 --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmation.php @@ -0,0 +1,90 @@ +_type; + } + + /** + * Устанавливает тип сценария подтверждения + * @param string $value + */ + protected function setType($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException( + 'Empty value for "type" parameter in SelfEmployedRequestConfirmation', + 0, + 'confirmation.type' + ); + } + if (!TypeCast::canCastToEnumString($value)) { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "type" parameter in SelfEmployedRequestConfirmation', + 0, + 'confirmation.type', + $value + ); + } + if (!SelfEmployedConfirmationType::valueExists($value)) { + throw new InvalidPropertyValueException( + 'Invalid value for "type" parameter in SelfEmployedRequestConfirmation', + 0, + 'confirmation.type', + $value + ); + } + $this->_type = (string)$value; + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationFactory.php b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationFactory.php new file mode 100644 index 00000000..acb6c0da --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationFactory.php @@ -0,0 +1,91 @@ + 'SelfEmployedRequestConfirmationRedirect', + ); + + /** + * Возвращает объект, соответствующий типу подтверждения платежа + * + * @param string $type Тип подтверждения платежа + * + * @return SelfEmployedRequestConfirmation + */ + public function factory($type) + { + if (!is_string($type)) { + throw new \InvalidArgumentException('Invalid confirmation value in confirmation factory'); + } + if (!array_key_exists($type, $this->typeClassMap)) { + throw new \InvalidArgumentException('Invalid confirmation value type "' . $type . '"'); + } + $className = __NAMESPACE__ . '\\' . $this->typeClassMap[$type]; + + return new $className(); + } + + /** + * Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + * + * @param array $data Массив данных подтверждения платежа + * @param string|null $type Тип подтверждения платежа + * + * @return SelfEmployedRequestConfirmation + */ + public function factoryFromArray(array $data, $type = null) + { + if ($type === null) { + if (array_key_exists('type', $data)) { + $type = $data['type']; + unset($data['type']); + } else { + throw new \InvalidArgumentException( + 'Parameter type not specified in SelfEmployedRequestConfirmation.factoryFromArray()' + ); + } + } + $confirmation = $this->factory($type); + foreach ($data as $key => $value) { + if ($confirmation->offsetExists($key)) { + $confirmation->offsetSet($key, $value); + } + } + + return $confirmation; + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationRedirect.php b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationRedirect.php new file mode 100644 index 00000000..c093b64c --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequestConfirmationRedirect.php @@ -0,0 +1,45 @@ +setType(SelfEmployedConfirmationType::REDIRECT); + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedRequestSerializer.php b/lib/Request/SelfEmployed/SelfEmployedRequestSerializer.php new file mode 100644 index 00000000..e6d66132 --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedRequestSerializer.php @@ -0,0 +1,58 @@ +hasItn()) { + $result['itn'] = $request->getItn(); + } + if ($request->hasPhone()) { + $result['phone'] = $request->getPhone(); + } + if ($request->hasConfirmation()) { + $result['confirmation'] = $request->getConfirmation()->toArray(); + } + + return $result; + } +} diff --git a/lib/Request/SelfEmployed/SelfEmployedResponse.php b/lib/Request/SelfEmployed/SelfEmployedResponse.php new file mode 100644 index 00000000..5162cb2c --- /dev/null +++ b/lib/Request/SelfEmployed/SelfEmployedResponse.php @@ -0,0 +1,42 @@ + + + The coding standard for YooKassa SDK. + + lib + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/phpdoc.xml b/phpdoc.xml index 0bed2116..122b839e 100644 --- a/phpdoc.xml +++ b/phpdoc.xml @@ -9,7 +9,7 @@ .phpdoc - + latest @@ -34,9 +34,12 @@ extends implements + + examples + YooKassa true -