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

<?php

namespace LDC\LDCCRM\Models;

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

/**
 * This class represents the customer info with
 * the account validation status
 *
 * @property int $operation The arcadia operation code
 *                          Validate: int
 *                          Required
 *
 * @property string $email Must be a rfc valid email on a valid domain name
 * @property string $firstname The account first name
 * @property string $lastname The account last name
 * @property string $phone The account phone
 * @property string $address The account address (street number, name, build, flat number)
 * @property string $address2 The account phone (address complement)
 * @property string $city The account city name
 * @property string $postcode The account city postcode
 *
 * @property int $support_code The arcadia support code
 * @property string $label_type_support The arcadia type support label
 * @property string $order_date The arcadia order date  'yyyy-mm-dd HH:ii:ss'
 * @property string $code_unique The arcadia code unique
 * @property string $code_on_pack The arcadia code on pack
 *
 * @category Api Models
 * @package LDCCrmClient
 * @subpackage models
 */
class ArcadiaMailGame extends CrmClientModel
{

    /**
     * An RFC Valid Email
     *
     * Validate: rfc,dns,spoof,filter
     *
     * Required
     * Min length N/A
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $email = null;

    /**
     * First name
     *
     * Required
     * Min length 2
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $firstname = null;

    /**
     * Last name
     *
     * Required
     * Min length 2
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $lastname = null;

    /**
     * The user phone
     *
     * Validate: sometimes,string
     *
     * Required
     * Min length NA
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $phone = null;

    /**
     * The user address (street number, name, etc)
     *
     * Validate: sometimes,string
     *
     * Min length NA
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $address = null;

    /**
     * The user address 2nd part (street number, name, more, etc)
     *
     * Validate: sometimes,string
     *
     * Min length NA
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $address2 = null;

    /**
     * The user address city
     *
     * Validate: sometimes,string
     *
     * Min length NA
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $city = null;

    /**
     * The user address postcode
     *
     * Validate: string
     *
     * Required
     * Min length NA
     * Max length 255
     * Field Type varchar
     *
     * @var string
     */
    private $postcode = null;

    /**
     * @var int
     * @access private
     * */
    private $operation = null;

    /**
     * The arcadia support code
     *
     * Validate: int
     *
     * Required
     *
     * @var int
     */
    private $support_code = null;

    /**
     * The arcadia type support label
     *
     * Validate: string
     *
     * Required
     *
     * @var string
     */
    private $label_type_support = null;

    /**
     * The arcadia order date
     *
     * Validate: date
     *
     * Required
     *
     * @var string
     */
    private $order_date = null;

    /**
     * The arcadia code unique
     *
     * Validate: string
     *
     * Required
     *
     * @var string
     */
    private $code_unique = null;

    /**
     * The arcadia code on pack
     *
     * Validate: sometimes
     *
     * Required
     *
     * @var string
     */
    private $code_on_pack = null;

    /**
     * The crm customer fields
     *
     * @var array
     */
    protected $modelFields = [
        'email', 'firstname',
        'lastname', 'phone', 'address',
        'address2', 'city', 'postcode',
        'operation', 'support_code', 'label_type_support',
        'order_date', 'code_unique', 'code_on_pack'
    ];

    /**
     * Validation rules
     *
     * @var array
     */
    protected static $validation = [
        'email' => 'required|email',
        'firstname' => 'required|string|min:2|max:255',
        'lastname' => 'required|string|min:2|max:255',
        'phone' => 'sometimes|string|min:10|max:255',
        'address' => 'sometimes|string|max:255',
        'address2' => 'sometimes|string|max:255',
        'city' => 'sometimes|string|max:255',
        'postcode' => 'sometimes|string|max:255',
        'operation' => 'required|int',
        'support_code' => 'required|int',
        'label_type_support' => 'required|string|min:2|max:255',
        'order_date' => 'required|date_format:Y/m/d H:i:s',
        'code_unique' => 'required|string',
        'code_on_pack' => 'sometimes|string'
    ];

    public function __construct(array $properties = [])
    {
        parent::__construct();
        $this->fill($properties);
        return $this;
    }

    /**
     * Set prop
     *
     * @param string $field
     * @param mixed $value
     * @throws TypeError if the field has an incorrect value
     * @return mixed|null The input value or null is this prop does not exists
     */
    public function __set(string $field, $value)
    {
        $out = parent::__set($field, $value);
        if (in_array($field, $this->modelFields)) {
            $this->updatedValues[$field] = (\is_object($value) and
                get_class($value) === ArcadiaOrderType::class) ? $value->value : $value;
            $this->setRawProperty($this, $field, $this->updatedValues[$field]);
        }
        return $out;
    }

    /**
     * Fill data into this model
     * using validation rules
     *
     * @param array $properties
     * @return void
     * @throws TypeError if any valid is not validated
     */
    public function fill(array $properties)
    {
        if (isset($properties['state_order'])) {
            try {
                $properties['state_order'] = (\is_object($properties['state_order']) and
                    get_class($properties['state_order']) === ArcadiaOrderType::class) ?
                    $properties['state_order']->value : (ctype_digit($properties['state_order']) ?
                    (int)$properties['state_order'] : $properties['state_order']);
            } catch (TypeError $e) {
                // cast anyway
                $properties['state_order'] = (int)$properties['state_order'];
            }
        }
        parent::fill($properties);
    }

    // PUBLIC METHODS

    /**
     * Send The actual mail
     *
     * @return boolean true if succeeded
     * @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
     */
    public function send(): bool
    {
        $this->validateAllValues();
        static::setUpApiInterface(); // set apiInterface
        $request  = Utils::getResquest('apiV2.arcadia.outgoingMailGame', [], $this->jsonSerialize());
        $response = static::$apiInterface->call($request);
        if ($status = $response->status->equals(ApiStatus::OK())) {
            $this->updatedValues = [];
        }
        $this->isNew = !$status;
        return $status;
    }

    /**
     * Serialize this object to an array
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'deliver' => [
                'email' => $this->email,
                'firstname' => $this->firstname,
                'lastname' => $this->lastname,
                'phone' => $this->phone,
                'address' => $this->address,
                'address2' => $this->address2,
                'city' => $this->city,
                'postcode' => $this->postcode,
            ],
            'operation' => $this->operation,
            'support_code' => $this->support_code,
            'label_type_support' => $this->label_type_support,
            'order_date' => $this->order_date,
            'code_unique' => $this->code_unique,
            'code_on_pack' => $this->code_on_pack
        ];
    }
}