<?php


namespace App\Channels\Messages;


class SmsMessage
{

    /**
     * The devices token to send the message from.
     *
     * @var array|string
     */
    public $to;

    /**
     * The data of the Sms message.
     *
     * @var array
     */
    public $data;

    /**
     * The params that we define in sms.ir template
     * when we use ultraFastSend method
     *
     * @var array
     */
    public $params;

    /**
     * The id of template we define in sms.ir
     * when we use ultraFastSend method
     *
     * @var string
     */
    public $template_id;

    /**
     * The generated verification code.
     * when we use sendVerification method.
     *
     * @var string
     */
    public $verification_code;


    /**
     * Set the devices token to send the message from.
     *
     * @param  array|string  $to
     * @return $this
     */
    public function to($to)
    {
        $this->to = $to;

        return $this;
    }

    /**
     * Set the data of the sms message.
     *
     * @param  array  $data
     * @return $this
     */
    public function data(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Set the params of the sms message when we use ultraFastSend method
     *
     * @param array $params
     * @return $this
     */
    public function params(array $params)
    {
        foreach ($parameters as $key => $value) {
            $this->params[] = ['Parameter' => $key, 'ParameterValue' => $value];
        }
        return $this;
    }

    /**
     * Set the template_id of the sms message when we use ultraFastSend method
     *
     * @param string $template_id
     * @return $this
     */
    public function templateId(string $template_id)
    {
        $this->template_id = $template_id;

        return $this;
    }

    /**
     * Set verification_code of sms message when we use sendVerification method
     *
     * @param string $verification_code
     * @return $this
     */
    public function verificationCode(string $verification_code)
    {
        $this->verification_code = $verification_code;

        return $this;
    }

}