ldc-crm-client/src/Models/SingleOptin.php

<?php

namespace LDC\LDCCRM\Models;

use LDC\LDCCRM\Enums\ApiStatus;
use LDC\LDCCRM\Utils;

/**
 * This class allows to handle single opt in
 *
 * @category Api Models
 * @package LDCCrmClient
 * @subpackage models
 * @author Jérémy Munsch <jeremy.munsch@ldc.fr>
 */
abstract class SingleOptin extends CrmClientModel
{
    /**
     * Validation rules
     *
     * @var array
     */
    protected static $validation = [
        'email' => 'required|email',
        'opt_in' => 'required|bool',
    ];

    /**
     * Set the single opt in status for an email
     *
     * @param string  $email
     * @param boolean $opt_in
     * @return boolean true if succeeded
     * @throws \LDC\LDCCRM\Exceptions\ValidationException If a field email could not be validated.
     * @throws \LDC\LDCCRM\Exceptions\CrmException If an error occurs on server side or on getting response.
     * @throws \LDC\LDCCRM\Exceptions\ApiErrorException If any error or \LDC\LDCCRM\Enums\ApiError occurs.
     * Possibles are : - singleOptinCustomerExists, If a customer exists with this email.
     * @phpcs:ignore Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
     */
    public static function setStatus(string $email, bool $opt_in): bool
    {
        self::validateValue('email', $email);
        static::setUpApiInterface();
        $request = Utils::getResquest('apiV2.optin', [], [
            'email' => $email,
            'opt_in' => $opt_in
        ]);

        $response = static::$apiInterface->call($request);
        return $response->status->equals(ApiStatus::OK());
    }
}