<?php

/**
 * The MIT License
 *
 * Copyright (c) 2023 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace YooKassa\Model\PersonalData;

use YooKassa\Common\AbstractEnum;

/**
 * Класс, представляющий модель PersonalDataStatus.
 *
 * Статус персональных данных.
 *
 * Возможные значения:
 * - `waiting_for_operation` — данные сохранены, но не использованы при проведении выплаты;
 * - `active` — данные сохранены и использованы при проведении выплаты; данные можно использовать повторно до срока, указанного в параметре `expires_at`;
 * - `canceled` — хранение данных отменено, данные удалены, инициатор и причина отмены указаны в объекте `cancellation_details` (финальный и неизменяемый статус).
 *
 * [Подробнее о жизненном цикле персональных данных](/developers/payouts/scenario-extensions/recipient-check#lifecircle)
 *
 * @package YooKassa\Model
 * @author  cms@yoomoney.ru
 */
class PersonalDataStatus extends AbstractEnum
{
    /** Данные сохранены, но не использованы при проведении выплаты */
    const WAITING_FOR_OPERATION = 'waiting_for_operation';
    /** Данные сохранены и использованы при проведении выплаты */
    const ACTIVE = 'active';
    /** Хранение данных отменено */
    const CANCELED = 'canceled';

    /**
     * @var array Массив принимаемых enum'ом значений
     */
    protected static $validValues = array(
        self::WAITING_FOR_OPERATION => true,
        self::ACTIVE                => true,
        self::CANCELED              => true,
    );
}
