rezahmady / smsir

src/SmsirClient.php

<?php

declare(strict_types=1);

namespace Rezahmady\Smsir;

use GuzzleHttp\Client;
use Rezahmady\Smsir\Responses\SMSLine;
use Psr\Http\Message\ResponseInterface;
use Rezahmady\Smsir\Responses\Message;
use GuzzleHttp\Exception\GuzzleException;
use Rezahmady\Smsir\Responses\SentMessage;
use Rezahmady\Smsir\Responses\SendResponse;
use Rezahmady\Smsir\Responses\CreditResponse;
use Rezahmady\Smsir\Responses\ReceivedMessage;
use Rezahmady\Smsir\Responses\SMSLinesResponse;
use Rezahmady\Smsir\Responses\SentMessagesResponse;
use Rezahmady\Smsir\Responses\VerificationCodeResponse;
use Rezahmady\Smsir\Responses\ReceivedMessagesResponse;

class SmsirClient
{
    private $userApiKey;
    private $secretKey;
    private $token;
    private $lineNumber;
    private $client;

    /**
     * Create a new SMSIR Instance
     * @param string $userApiKey
     * @param string $secretKey
     * @param string $lineNumber
     * @param int $timeout
     */
    public function __construct(string $userApiKey, string $secretKey, string $lineNumber, int $timeout = 10)
    {
        $this->userApiKey = $userApiKey;
        $this->secretKey = $secretKey;
        $this->token = "";
        $this->lineNumber = $lineNumber;

        $this->client = new Client([
            'base_uri' => 'http://restfulsms.com/api/',
            'timeout' => $timeout,
        ]);
    }

    /**
     * this method return your credit in sms.ir (sms credit, not money)
     *
     * @return CreditResponse
     * @throws GuzzleException
     */
    public function smsCredit(): CreditResponse
    {
        $result = $this->executeRequest('credit');
        $json = json_decode($result->getBody()->getContents(), true);
        return new CreditResponse($json['IsSuccessful'], $json['Message'], $json['Credit']);
    }

    /**
     * @param string $route
     * @param null $body

Are you sure the doc-type for parameter $body is correct as it would always require null to be passed?

     * @return ResponseInterface
     * @throws GuzzleException
     */
    private function executeRequest(string $route, $body = null): ResponseInterface
    {
        if (is_null($body)) {
            return $this->client->get($route, [
                'headers' => [
                    'x-sms-ir-secure-token' => $this->getToken(),
                ],
            ]);
        }
        return $this->client->post($route, [
            'json' => $body,
            'headers' => [
                'x-sms-ir-secure-token' => $this->getToken(),
            ],
        ]);
    }

    /**
     * this method used in every request to get the token at first.
     *
     * @return mixed - the Token for use api
     * @return string
     * @throws GuzzleException
     */
    private function getToken(): string
    {
        $body = [
            'UserApiKey' => $this->userApiKey,
            'SecretKey' => $this->secretKey,
        ];
        $result = $this->client->post('Token', [
            'json' => $body,
        ]);
        return json_decode($result->getBody()->getContents(), true)['TokenKey'];
    }

    /**
     * by this method you can fetch all of your sms lines.
     *
     * @return SMSLinesResponse
     * @throws GuzzleException
     */
    public function getSMSLines(): SMSLinesResponse
    {
        $result = $this->executeRequest('SMSLine');
        $json = json_decode($result->getBody()->getContents(), true);
        $lineArray = [];
        foreach ($json['SMSLines'] as $SMSLine) {
            $lineArray[] = new SMSLine((int)$SMSLine['ID'], (string)$SMSLine['LineNumber']);
        }
        return new SMSLinesResponse($json['IsSuccessful'], $json['Message'], $lineArray);
    }

    /**
     * Simple send message with sms.ir account and line number
     *
     * @param array $messages Messages - Count must be equal with $mobileNumbers
     * @param array $mobileNumbers Numbers - must be equal with $messages
     * @param null $sendDateTime Avoid this param if you want to send message now

Are you sure the doc-type for parameter $sendDateTime is correct as it would always require null to be passed?

     * @return SendResponse
     * @throws GuzzleException
     */
    public function send(array $messages, array $mobileNumbers, $sendDateTime = null): SendResponse
    {
        $body = [
            'Messages' => $messages,
            'MobileNumbers' => $mobileNumbers,
            'LineNumber' => $this->lineNumber,
        ];
        if ($sendDateTime !== null) {
            $body['SendDateTime'] = $sendDateTime;
        }
        $result = $this->executeRequest('MessageSend', $body);
        $json = json_decode($result->getBody()->getContents(), true);
        $sentMessages = [];
        foreach ($json['Ids'] as $sentMessage) {
            $sentMessages[] = new SentMessage((int)$sentMessage['ID'], (string)$sentMessage['MobileNo']);
        }
        return new SendResponse($json['IsSuccessful'], $json['Message'], $json['BatchKey'], $sentMessages);
    }

    /**
     * this method send a verification code to your customer. need active the module at panel first.
     *
     * @param string $code
     * @param string $mobileNumber
     * @return VerificationCodeResponse
     * @throws GuzzleException
     */
    public function sendVerificationCode(string $code, string $mobileNumber): VerificationCodeResponse
    {
        $body = [
            'Code' => $code,
            'MobileNumber' => $mobileNumber,
        ];
        $result = $this->executeRequest('VerificationCode', $body);
        $json = json_decode($result->getBody()->getContents(), true);
        return new VerificationCodeResponse(
            $json['IsSuccessful'],
            $json['Message'],
            (string)$json['VerificationCodeId']
        );
    }


    /**
     * @param array $parameters
     * @param string $templateId
     * @param string $mobileNumber
     * @return VerificationCodeResponse
     * @throws GuzzleException
     */
    public function ultraFastSend(array $parameters, string $templateId, string $mobileNumber): VerificationCodeResponse
    {
        $params = [];
        foreach ($parameters as $key => $value) {
            $params[] = ['Parameter' => $key, 'ParameterValue' => $value];
        }
        $body = [
            'ParameterArray' => $params,
            'TemplateId' => $templateId,
            'Mobile' => $mobileNumber,
        ];
        $result = $this->executeRequest('UltraFastSend', $body);
        $json = json_decode($result->getBody()->getContents(), true);
        return new VerificationCodeResponse(
            $json['IsSuccessful'],
            $json['Message'],
            (string)$json['VerificationCodeId']
        );
    }

    /**
     * this method used for fetch your sent messages
     *
     * @param $fromDate = from date (example: 1399/06/01)

The doc comment = at position 0 could not be parsed: Unknown type name '=' at position 0 in =.

     * @param $toDate = to date (example: 1399/08/25)
     * @param int $pageNumber = the page number
     * @param int $perPage = how many sms you want to fetch in every page
     * @return SentMessagesResponse
     * @throws GuzzleException
     */
    public function getSentMessages($fromDate, $toDate, int $pageNumber = 1, int $perPage = 100): SentMessagesResponse
    {
        $result = $this->executeRequest("MessageSend?Shamsi_FromDate=$fromDate&Shamsi_ToDate=$toDate&RowsPerPage=$perPage&RequestedPageNumber=$pageNumber");
        $json = json_decode($result->getBody()->getContents(), true);
        $messages = [];
        foreach ($json['Messages'] as $message) {
            $messages[] = new Message(
                (int)$message['ID'],
                (string)$message['LineNumber'],
                (string)$message['SMSMessageBody'],
                (string)$message['MobileNo'],
                (string)$message['TypeOfMessage'],
                (string)$message['NativeDeliveryStatus'],
                (string)$message['ToBeSentAt'],
                (string)$message['SendDateTimeLatin'],
                (string)$message['PersianSendDateTime'],
                (bool)$message['IsChecked'],
                (bool)$message['IsError'],
            );
        }
        return new SentMessagesResponse(
            (bool)$json['IsSuccessful'],
            $json['Message'],
            (int)$json['CountOfAll'],
            $messages
        );
    }

    /**
     * this method used for fetch received messages
     *
     * @param $fromDate = from date (example: 1399/06/01)

The doc comment = at position 0 could not be parsed: Unknown type name '=' at position 0 in =.

     * @param $toDate = to date (example: 1399/08/25)
     * @param int $pageNumber = the page number
     * @param int $perPage = how many sms you want to fetch in every page
     * @return ReceivedMessagesResponse
     * @throws GuzzleException
     *
     */
    public function getReceivedMessages(
        $fromDate,
        $toDate,
        int $pageNumber = 1,
        int $perPage = 100
    ): ReceivedMessagesResponse {
        $result = $this->executeRequest("ReceiveMessage?Shamsi_FromDate=$fromDate&Shamsi_ToDate=$toDate&RowsPerPage=$perPage&RequestedPageNumber=$pageNumber");
        $json = json_decode($result->getBody()->getContents(), true);
        $messages = [];
        foreach ($json['Messages'] as $message) {
            $messages[] = new ReceivedMessage(
                (int)$message['ID'],
                (string)$message['LineNumber'],
                (string)$message['SMSMessageBody'],
                (string)$message['MobileNo'],
                (string)$message['TypeOfMessage'],
                (string)$message['LatinReceiveDateTime'],
                (string)$message['ReceiveDateTime']
            );
        }
        return new ReceivedMessagesResponse(
            (bool)$json['IsSuccessful'],
            $json['Message'],
            (int)$json['CountOfAll'],
            $messages
        );
    }
}