Merge pull request #54 from Chupocabra/refactor-members_req

Use CommonFields in MembersRequest

.github/workflows/ci.yml

@@ -15,14 +15,14 @@ jobs:
       matrix:
         php-version: ['7.3', '7.4', '8.0', '8.1']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup PHP ${{ matrix.php-version }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer:v1
       - name: Composer cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ env.HOME }}/.composer/cache
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}

phpstan-baseline.neon

@@ -1355,6 +1355,11 @@ parameters:
 			count: 1
 			path: src/Bot/Model/Request/MembersRequest.php
 
+		-
+			message: "#^Method RetailCrm\\\\Mg\\\\Bot\\\\Model\\\\Request\\\\MembersRequest\\:\\:setId\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: src/Bot/Model/Request/MembersRequest.php
+
 		-
 			message: "#^Method RetailCrm\\\\Mg\\\\Bot\\\\Model\\\\Request\\\\MembersRequest\\:\\:setSince\\(\\) has no return typehint specified\\.$#"
 			count: 1

src/Bot/Client.php

@@ -11,9 +11,8 @@
 namespace RetailCrm\Mg\Bot;
 
 use Psr\Http\Message\ResponseInterface;
-use RetailCrm\Common\Url;
 use RetailCrm\Common\Serializer;
-use RetailCrm\Mg\Bot\Model\ModelAdapter;
+use RetailCrm\Common\Url;
 use RetailCrm\Mg\Bot\Model\Entity\Bot;
 use RetailCrm\Mg\Bot\Model\Entity\Channel\Channel;
 use RetailCrm\Mg\Bot\Model\Entity\Chat\Chat;
@@ -22,13 +21,16 @@ use RetailCrm\Mg\Bot\Model\Entity\Command;
 use RetailCrm\Mg\Bot\Model\Entity\Customer;
 use RetailCrm\Mg\Bot\Model\Entity\Dialog;
 use RetailCrm\Mg\Bot\Model\Entity\Message\Message;
+use RetailCrm\Mg\Bot\Model\Entity\Template\Template;
 use RetailCrm\Mg\Bot\Model\Entity\User;
+use RetailCrm\Mg\Bot\Model\ModelAdapter;
+use RetailCrm\Mg\Bot\Model\ModelInterface;
 use RetailCrm\Mg\Bot\Model\Request\UploadFileByUrlRequest;
 use RetailCrm\Mg\Bot\Model\Response\AssignResponse;
-use RetailCrm\Mg\Bot\Model\Response\UnassignResponse;
 use RetailCrm\Mg\Bot\Model\Response\ErrorOnlyResponse;
 use RetailCrm\Mg\Bot\Model\Response\FullFileResponse;
 use RetailCrm\Mg\Bot\Model\Response\MessageSendResponse;
+use RetailCrm\Mg\Bot\Model\Response\UnassignResponse;
 use RetailCrm\Mg\Bot\Model\Response\UploadFileResponse;
 
 /**
@@ -460,6 +462,47 @@ class Client
         return $adapter->getResponseModel($response);
     }
 
+
+    /**
+     * Returns templates list
+     *
+     * @return Template[]
+     * @throws \Exception
+     */
+    public function templates(): array
+    {
+        $response = $this->client->makeRequest(
+            '/templates',
+            HttpClient::METHOD_GET
+        );
+
+        $adapter = new ModelAdapter(Template::class);
+
+        return $adapter->getResponseList($response);
+    }
+
+    /**
+     * Send a template message
+     *
+     * @param string $templateId
+     * @param Model\Request\TemplateSendRequest $request Request parameters
+     *
+     * @return \RetailCrm\Mg\Bot\Model\ModelInterface
+     * @throws \Exception
+     */
+    public function templateSend(string $templateId, Model\Request\TemplateSendRequest $request): ModelInterface
+    {
+        $response = $this->client->makeRequest(
+            sprintf('/templates/%d/send', $templateId),
+            HttpClient::METHOD_POST,
+            $request
+        );
+
+        $adapter = new ModelAdapter(MessageSendResponse::class);
+
+        return $adapter->getResponseModel($response);
+    }
+
     /**
      * Returns filtered users list
      *

src/Bot/Model/Constants.php

@@ -38,6 +38,7 @@ class Constants
 
     const BOT_ROLE_DISTRIBUTOR = "distributor";
     const BOT_ROLE_RESPONSIBLE = "responsible";
+    const BOT_ROLE_HIDDEN = "hidden";
 
     const MESSAGE_SCOPE_PUBLIC  = "public";
     const MESSAGE_SCOPE_PRIVATE = "private";

src/Bot/Model/Entity/Chat/Chat.php

@@ -113,6 +113,14 @@ class Chat implements ModelInterface
      */
     private $lastActivity;
 
+    /**
+     * @var \DateTime $replyDeadline
+     *
+     * @Type("DateTime<'Y-m-d\TH:i:sP'>")
+     * @Accessor(getter="getReplyDeadline",setter="setReplyDeadline")
+     */
+    private $replyDeadline;
+
     /**
      * @return string|null
      */
@@ -288,4 +296,20 @@ class Chat implements ModelInterface
     {
         $this->lastActivity = $lastActivity;
     }
+
+    /**
+     * @return \DateTime
+     */
+    public function getReplyDeadline(): ?\DateTime
+    {
+        return $this->replyDeadline;
+    }
+
+    /**
+     * @param \DateTime $replyDeadline
+     */
+    public function setReplyDeadline(\DateTime $replyDeadline): void
+    {
+        $this->replyDeadline = $replyDeadline;
+    }
 }

src/Bot/Model/Entity/Message/Item.php

@@ -49,6 +49,15 @@ class Item implements ModelInterface
      */
     private $caption;
 
+    /**
+     * @var string $transcription
+     *
+     * @Type("string")
+     * @Accessor(getter="getTranscription",setter="setTranscription")
+     * @SkipWhenEmpty()
+     */
+    private $transcription;
+
     /**
      * @return string|null
      */
@@ -96,4 +105,20 @@ class Item implements ModelInterface
     {
         $this->caption = $caption;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getTranscription(): ?string
+    {
+        return $this->transcription;
+    }
+
+    /**
+     * @param string $transcription
+     */
+    public function setTranscription(string $transcription): void
+    {
+        $this->transcription = $transcription;
+    }
 }

src/Bot/Model/Entity/Responsible.php

@@ -49,6 +49,15 @@ class Responsible implements ModelInterface
      */
     private $type;
 
+    /**
+     * @var string $externalId
+     *
+     * @Type("string")
+     * @Accessor(getter="getExternalId",setter="setExternalId")
+     * @SkipWhenEmpty()
+     */
+    private $externalId;
+
     /**
      * @return string|null
      */
@@ -96,4 +105,20 @@ class Responsible implements ModelInterface
     {
         $this->type = $type;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getExternalId(): ?string
+    {
+        return $this->externalId;
+    }
+
+    /**
+     * @param string $externalId
+     */
+    public function setExternalId(string $externalId): void
+    {
+        $this->externalId = $externalId;
+    }
 }

src/Bot/Model/Entity/Template/Template.php

@@ -0,0 +1,385 @@
+<?php
+
+
+/**
+ * PHP version 7.1
+ *
+ * Template entity
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Entity\Template;
+
+use RetailCrm\Mg\Bot\Model\ModelInterface;
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+
+/**
+ * Template class
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+class Template implements ModelInterface
+{
+    /**
+     * @var int $id
+     *
+     * @Type("int")
+     * @Accessor(getter="getId",setter="setId")
+     */
+    private $id;
+
+    /**
+     * @var string $code
+     *
+     * @Type("string")
+     * @Accessor(getter="getCode",setter="setCode")
+     */
+    private $code;
+
+    /**
+     * @var int $channelId
+     *
+     * @Type("int")
+     * @Accessor(getter="getChannelId",setter="setChannelId")
+     */
+    private $channelId;
+
+    /**
+     * @var string $name
+     *
+     * @Type("string")
+     * @Accessor(getter="getName",setter="setName")
+     */
+    private $name;
+
+    /**
+     * @var bool $enabled
+     *
+     * @Type("bool")
+     * @Accessor(getter="getEnabled",setter="setEnabled")
+     */
+    private $enabled;
+
+    /**
+     * @var string $type
+     *
+     * @Type("string")
+     * @Accessor(getter="getType",setter="setType")
+     */
+    private $type;
+
+    /**
+     * @var array<string, string> $template
+     *
+     * @Type("array")
+     * @Accessor(getter="getTemplate",setter="setTemplate")
+     */
+    private $template;
+
+    /**
+     * @var string $body
+     *
+     * @Type("string")
+     * @Accessor(getter="getBody",setter="setBody")
+     */
+    private $body;
+
+    /**
+     * @var string $lang
+     *
+     * @Type("string")
+     * @Accessor(getter="getLang",setter="setLang")
+     */
+    private $lang;
+
+    /**
+     * @var string $category
+     *
+     * @Type("string")
+     * @Accessor(getter="getCategory",setter="setCategory")
+     */
+    private $category;
+
+    /**
+     * @var string $verificationStatus
+     *
+     * @Type("string")
+     * @Accessor(getter="getVerificationStatus",setter="setVerificationStatus")
+     */
+    private $verificationStatus;
+
+    /**
+     * @var string $rejectionReason
+     *
+     * @Type("string")
+     * @Accessor(getter="getRejectionReason",setter="setRejectionReason")
+     */
+    private $rejectionReason;
+
+    /**
+     * @var string $quality
+     *
+     * @Type("string")
+     * @Accessor(getter="getQuality",setter="setQuality")
+     * @SkipWhenEmpty()
+     */
+    private $quality;
+
+    /**
+     * @var array<string, string> $header
+     *
+     * @Type("array")
+     * @Accessor(getter="getHeader",setter="setHeader")
+     * @SkipWhenEmpty()
+     */
+    private $header;
+
+    /**
+     * @var array<string, array<string, string>> $buttons
+     *
+     * @Type("array")
+     * @Accessor(getter="getButtons",setter="setButtons")
+     * @SkipWhenEmpty()
+     */
+    private $buttons;
+
+    /**
+     * @return int|null
+     */
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @param int $id
+     */
+    public function setId(int $id): void
+    {
+        $this->id = $id;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCode(): ?string
+    {
+        return $this->code;
+    }
+
+    /**
+     * @param string $code
+     */
+    public function setCode(string $code): void
+    {
+        $this->code = $code;
+    }
+
+    /**
+     * @return int|null
+     */
+    public function getChannelId(): ?int
+    {
+        return $this->channelId;
+    }
+
+    /**
+     * @param int $channelId
+     */
+    public function setChannelId(int $channelId): void
+    {
+        $this->channelId = $channelId;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     */
+    public function setName(string $name): void
+    {
+        $this->name = $name;
+    }
+
+    /**
+     * @return bool|null
+     */
+    public function getEnabled(): ?bool
+    {
+        return $this->enabled;
+    }
+
+    /**
+     * @param bool $enabled
+     */
+    public function setEnabled(bool $enabled): void
+    {
+        $this->enabled = $enabled;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getType(): ?string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @param string $type
+     */
+    public function setType(string $type): void
+    {
+        $this->type = $type;
+    }
+
+    /**
+     * @return array<string, string>|null
+     */
+    public function getTemplate(): ?array
+    {
+        return $this->template;
+    }
+
+    /**
+     * @param array<string, string> $template
+     */
+    public function setTemplate(array $template): void
+    {
+        $this->template = $template;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getBody(): ?string
+    {
+        return $this->body;
+    }
+
+    /**
+     * @param string $body
+     */
+    public function setBody(string $body): void
+    {
+        $this->body = $body;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getVerificationStatus(): ?string
+    {
+        return $this->verificationStatus;
+    }
+
+    /**
+     * @param string $verificationStatus
+     */
+    public function setVerificationStatus(string $verificationStatus): void
+    {
+        $this->verificationStatus = $verificationStatus;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getLang(): ?string
+    {
+        return $this->lang;
+    }
+
+    /**
+     * @param string $lang
+     */
+    public function setLang(string $lang): void
+    {
+        $this->lang = $lang;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCategory(): ?string
+    {
+        return $this->category;
+    }
+
+    /**
+     * @param string $category
+     */
+    public function setCategory(string $category): void
+    {
+        $this->category = $category;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getRejectionReason(): ?string
+    {
+        return $this->rejectionReason;
+    }
+
+    /**
+     * @param string $rejectionReason
+     */
+    public function setRejectionReason(string $rejectionReason): void
+    {
+        $this->rejectionReason = $rejectionReason;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getQuality(): ?string
+    {
+        return $this->quality;
+    }
+
+    public function setQuality(string $quality): void
+    {
+        $this->quality = $quality;
+    }
+
+    /**
+     * @return array<string, string>|null
+     */
+    public function getHeader(): ?array
+    {
+        return $this->header;
+    }
+
+    /**
+     * @param array<string, string> $header
+     */
+    public function setHeader(array $header): void
+    {
+        $this->header = $header;
+    }
+
+    /**
+     * @return array<string, array<string, string>>|null
+     */
+    public function getButtons(): ?array
+    {
+        return $this->buttons;
+    }
+
+    /**
+     * @param array<string, array<string, string>> $buttons
+     */
+    public function setButtons(array $buttons): void
+    {
+        $this->buttons = $buttons;
+    }
+}

src/Bot/Model/Entity/Template/TemplateAttachment.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * PHP version 7.1
+ *
+ * TemplateAttachment entity
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Entity\Template;
+
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+use RetailCrm\Mg\Bot\Model\ModelInterface;
+
+/**
+ * TemplateAttachment class
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+class TemplateAttachment implements ModelInterface
+{
+    /**
+     * @var string $id
+     *
+     * @Type("string")
+     * @Accessor(getter="getId",setter="setId")
+     */
+    private $id;
+
+    /**
+     * @var string $caption
+     *
+     * @Type("string")
+     * @Accessor(getter="getCaption",setter="setCaption")
+     * @SkipWhenEmpty()
+     */
+    private $caption;
+
+    /**
+     * @return string|null
+     */
+    public function getId(): ?string
+    {
+        return $this->id;
+    }
+
+    /**
+     * @param string $id
+     * @return void
+     */
+    public function setId(string $id): void
+    {
+        $this->id = $id;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCaption(): ?string
+    {
+        return $this->caption;
+    }
+
+    /**
+     * @param string $caption
+     */
+    public function setCaption(string $caption): void
+    {
+        $this->caption = $caption;
+    }
+}

src/Bot/Model/Entity/Template/TemplateVariables.php

@@ -0,0 +1,120 @@
+<?php
+
+/**
+ * PHP version 7.1
+ *
+ * TemplateVariables entity
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Entity\Template;
+
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+use RetailCrm\Mg\Bot\Model\ModelInterface;
+
+/**
+ * TemplateVariables class
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Entity\Template
+ */
+class TemplateVariables implements ModelInterface
+{
+    /**
+     * @var array<string, string> $header
+     *
+     * @Type("array")
+     * @Accessor(getter="getHeader",setter="setHeader")
+     */
+    private $header;
+
+
+    /** @var array<TemplateAttachment> $attachments
+     *
+     * @Type("array")
+     * @Accessor(getter="getAttachments",setter="setAttachments")
+     */
+    private $attachments;
+
+    /**
+     * @var array<string, string> $body
+     *
+     * @Type("array")
+     * @Accessor(getter="getBody",setter="setBody")
+     */
+    private $body;
+
+    /**
+     * @var array<string, array<string, string>> $buttons
+     *
+     * @Type("array")
+     * @Accessor(getter="getButtons",setter="setButtons")
+     */
+    private $buttons;
+
+    /**
+     * @return array<string, string>|null
+     */
+    public function getHeader(): ?array
+    {
+        return $this->header;
+    }
+
+    /**
+     * @param array<string, string> $header
+     */
+    public function setHeader(array $header): void
+    {
+        $this->header = $header;
+    }
+
+    /**
+     * @return array<string, string>|null
+     */
+    public function getBody(): ?array
+    {
+        return $this->body;
+    }
+
+    /**
+     * @param array<string, string> $body
+     */
+    public function setBody(array $body): void
+    {
+        $this->body = $body;
+    }
+
+    /**
+     * @return array<string, array<string, string>>|null
+     */
+    public function getButtons(): ?array
+    {
+        return $this->buttons;
+    }
+
+    /**
+     * @param array<string, array<string, string>> $buttons
+     */
+    public function setButtons(array $buttons): void
+    {
+        $this->buttons = $buttons;
+    }
+
+    /**
+     * @return TemplateAttachment[]|null
+     */
+    public function getAttachments(): ?array
+    {
+        return $this->attachments;
+    }
+
+    /**
+     * @param TemplateAttachment[] $attachments
+     */
+    public function setAttachments(array $attachments): void
+    {
+        $this->attachments = $attachments;
+    }
+}

src/Bot/Model/Entity/User.php

@@ -142,6 +142,15 @@ class User implements ModelInterface
      */
     private $revokedAt;
 
+    /**
+     * @var bool $isSystem
+     *
+     * @Type("bool")
+     * @Accessor(getter="isSystem",setter="setIsSystem")
+     * @SkipWhenEmpty()
+     */
+    private $isSystem;
+
     /**
      * @return string|null
      */
@@ -349,4 +358,20 @@ class User implements ModelInterface
     {
         $this->revokedAt = $revokedAt;
     }
+
+    /**
+     * @return bool|null
+     */
+    public function isSystem(): ?bool
+    {
+        return $this->isSystem;
+    }
+
+    /**
+     * @param bool $isSystem
+     */
+    public function setIsSystem(bool $isSystem): void
+    {
+        $this->isSystem = $isSystem;
+    }
 }

src/Bot/Model/Request/ChatsRequest.php

@@ -24,6 +24,7 @@ class ChatsRequest implements ModelInterface
 {
     use CommonFields;
     use PageLimit;
+    use IncludeMassCommunication;
 
     /**
      * @Type("int")
@@ -48,6 +49,15 @@ class ChatsRequest implements ModelInterface
      */
     private $customerId;
 
+    /**
+     * @var int $sinceId
+     *
+     * @Type("int")
+     * @Accessor(getter="getSinceId",setter="setSinceId")
+     * @SkipWhenEmpty()
+     */
+    private $sinceId;
+
     /**
      * @return int
      */
@@ -96,4 +106,21 @@ class ChatsRequest implements ModelInterface
     {
         $this->customerId = $customerId;
     }
+
+    /**
+     * @return int|null
+     */
+    public function getSinceId()
+    {
+        return $this->sinceId;
+    }
+
+    /**
+     * @param int $sinceId
+     * @return void
+     */
+    public function setSinceId($sinceId)
+    {
+        $this->sinceId = $sinceId;
+    }
 }

src/Bot/Model/Request/DialogsRequest.php

@@ -24,6 +24,7 @@ class DialogsRequest implements ModelInterface
 {
     use CommonFields;
     use PageLimit;
+    use IncludeMassCommunication;
 
     /**
      * @var int $sinceId

src/Bot/Model/Request/IncludeMassCommunication.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * PHP version 7.1
+ *
+ * Common fields
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Request;
+
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+
+/**
+ * CommonFields trait
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+trait IncludeMassCommunication
+{
+    /**
+     * @var int $includeMassCommunication
+     *
+     * @Type("int")
+     * @Accessor(getter="getIncludeMassCommunication",setter="setIncludeMassCommunication")
+     * @SkipWhenEmpty
+     */
+    private $includeMassCommunication;
+
+    /**
+     * @return int
+     */
+    public function getIncludeMassCommunication()
+    {
+        return $this->includeMassCommunication;
+    }
+
+    /**
+     * @param int $includeMassCommunication
+     */
+    public function setIncludeMassCommunication(?int $includeMassCommunication): void
+    {
+        $this->includeMassCommunication = $includeMassCommunication;
+    }
+}

src/Bot/Model/Request/MembersRequest.php

@@ -22,6 +22,7 @@ use RetailCrm\Mg\Bot\Model\ModelInterface;
  */
 class MembersRequest implements ModelInterface
 {
+    use CommonFields;
     use PageLimit;
 
     /**
@@ -51,24 +52,6 @@ class MembersRequest implements ModelInterface
      */
     private $state;
 
-    /**
-     * @var string $since
-     *
-     * @Type("string")
-     * @Accessor(getter="getSince",setter="setSince")
-     * @SkipWhenEmpty
-     */
-    private $since;
-
-    /**
-     * @var string $until
-     *
-     * @Type("string")
-     * @Accessor(getter="getUntil",setter="setUntil")
-     * @SkipWhenEmpty
-     */
-    private $until;
-
     /**
      * @return int
      */
@@ -116,36 +99,4 @@ class MembersRequest implements ModelInterface
     {
         $this->state = $state;
     }
-
-    /**
-     * @return string
-     */
-    public function getSince()
-    {
-        return $this->since;
-    }
-
-    /**
-     * @param string $since
-     */
-    public function setSince(string $since)
-    {
-        $this->since = $since;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUntil()
-    {
-        return $this->until;
-    }
-
-    /**
-     * @param string $until
-     */
-    public function setUntil(string $until)
-    {
-        $this->until = $until;
-    }
 }

src/Bot/Model/Request/MessagesRequest.php

@@ -23,6 +23,7 @@ use RetailCrm\Mg\Bot\Model\ModelInterface;
 class MessagesRequest implements ModelInterface
 {
     use CommonFields;
+    use IncludeMassCommunication;
 
     /**
      * @var int $chatId

src/Bot/Model/Request/TemplateSendRequest.php

@@ -0,0 +1,77 @@
+<?php
+
+/**
+ * PHP version 7.1
+ *
+ * Template send request
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Request;
+
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+use RetailCrm\Mg\Bot\Model\Entity\Template\TemplateVariables;
+use RetailCrm\Mg\Bot\Model\ModelInterface;
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * TemplateSendRequest class
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+class TemplateSendRequest  implements ModelInterface
+{
+    /**
+     * @var string $phone
+     *
+     * @Type("string")
+     * @Accessor(getter="getPhone",setter="setPhone")
+     *
+     * @Assert\NotBlank
+     */
+    private $phone;
+
+    /**
+     * @var TemplateVariables $args
+     *
+     * @Type("RetailCrm\Mg\Bot\Model\Entity\Template\TemplateVariables")
+     * @Accessor(getter="getArgs",setter="setArgs")
+     * @SkipWhenEmpty()
+     */
+    private $args;
+
+    /**
+     * @return string
+     */
+    public function getPhone(): string
+    {
+        return $this->phone;
+    }
+
+    /**
+     * @param string $phone
+     */
+    public function setPhone(string $phone): void
+    {
+        $this->phone = $phone;
+    }
+
+    /**
+     * @return TemplateVariables|null
+     */
+    public function getArgs(): ?TemplateVariables
+    {
+        return $this->args;
+    }
+
+    /**
+     * @param TemplateVariables $args
+     */
+    public function setArgs(TemplateVariables $args): void
+    {
+        $this->args = $args;
+    }
+}

tests/Bot/Tests/TemplatesTest.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace RetailCrm\Mg\Bot\Tests;
+
+use RetailCrm\Common\Exception\NotFoundException;
+use RetailCrm\Mg\Bot\Model\Request\TemplateSendRequest;
+use RetailCrm\Mg\Bot\Model\Response\MessageSendResponse;
+use RetailCrm\Mg\Bot\Test\TestCase;
+use RetailCrm\Mg\Bot\Model\Entity\Template;
+
+/**
+ * PHP version 7.0
+ *
+ * Class TemplatesTest
+ *
+ * @package RetailCrm\Mg\Bot\Tests
+ */
+class TemplatesTest extends TestCase
+{
+    /**
+     * @group("templates")
+     * @throws \Exception
+     */
+    public function testTemplatesList()
+    {
+        $client = self::getApiClient(
+            null,
+            null,
+            false,
+            $this->getJsonResponse('templates')
+        );
+
+        $response = $client->templates();
+
+        static::assertCount(2, $response, "Incorrect templates count");
+        static::assertInstanceOf(Template\Template::class, $response[0], "Incorrect template instance");
+
+        $templateType = $response[0]->getHeader()['content']['type'];
+        static::assertStringContainsString("video", $templateType, "Incorrect template type");
+    }
+
+    /**
+     * @group("templates")
+     * @throws \Exception
+     */
+    public function testTemplateSendNotFound()
+    {
+        $this->expectException(NotFoundException::class);
+
+        $client = self::getApiClient(
+            null,
+            null,
+            false,
+            $this->getErrorsResponse(404, "template id=3 was not found")
+        );
+
+        $request = new TemplateSendRequest();
+        $request->setPhone('123');
+
+        $client->templateSend(3, $request);
+    }
+
+    /**
+     * @group("templates")
+     * @throws \Exception
+     */
+    public function testTemplateSendVariablesError()
+    {
+        $this->expectException(NotFoundException::class);
+
+        $client = self::getApiClient(
+            null,
+            null,
+            false,
+            $this->getErrorsResponse(404, "variables number doesn't match template")
+        );
+
+        $request = new TemplateSendRequest();
+        $request->setPhone('123');
+
+        $client->templateSend(2, $request);
+    }
+
+    /**
+     * @group("templates")
+     * @throws \Exception
+     */
+    public function testTemplateSendSuccess()
+    {
+        $client = self::getApiClient(
+            null,
+            null,
+            false,
+            $this->getResponse(
+                '{"message_id":4242,"time":"2019-06-24T06:02:04.434291791Z"}',
+                201
+            )
+        );
+
+        $request = new TemplateSendRequest();
+        $request->setPhone('123');
+
+        $response = $client->templateSend(1, $request);
+
+        self::assertInstanceOf(MessageSendResponse::class, $response);
+
+        if ($response instanceof MessageSendResponse) {
+            self::assertTrue($response->isSuccessful());
+            self::assertCount(0, $response->getErrors());
+            self::assertEquals(4242, $response->getMessageId());
+        }
+    }
+}

tests/Resources/chats.json

@@ -57,6 +57,7 @@
     "author_id": 0,
     "last_message": null,
     "last_activity": "2019-06-11T17:36:20+03:00",
+    "reply_deadline": "2019-06-18T17:36:20Z",
     "created_at": "2019-06-11T12:49:26.938879Z",
     "updated_at": "2019-06-14T14:40:28.7111Z"
   },
@@ -129,6 +130,7 @@
       }
     },
     "last_activity": "2019-06-13T11:07:14+03:00",
+    "reply_deadline": "2019-06-20T11:07:14Z",
     "created_at": "2019-06-11T07:34:16.082957Z",
     "updated_at": "2019-06-16T08:10:28.657972Z"
   },
@@ -201,6 +203,7 @@
       }
     },
     "last_activity": "2019-06-13T11:07:14+03:00",
+    "reply_deadline":"2019-06-20T11:07:14Z",
     "created_at": "2019-06-11T07:34:16Z",
     "updated_at": "2019-06-16T08:10:28Z"
   }

tests/Resources/dialogReassigned.json

@@ -1 +1 @@
-{"responsible":{"type":"user","id":4,"assigned_at":"2019-06-21T08:01:09Z"},"is_reassign":true,"previous_responsible":{"type":"user","id":12,"assigned_at":"2019-06-11T12:49:34Z"},"left_user_id":12}
+{"responsible":{"type":"user","id":4,"external_id": "4","assigned_at":"2019-06-21T08:01:09Z"},"is_reassign":true,"previous_responsible":{"type":"user","id":12,"external_id": "12","assigned_at":"2019-06-11T12:49:34Z"},"left_user_id":12}

tests/Resources/dialogUnassigned.json

@@ -1 +1 @@
-{"previous_responsible":{"type":"user","id":12,"assigned_at":"2019-06-11T12:49:34Z"}}
+{"previous_responsible":{"type":"user","id":12,"external_id": "12","assigned_at":"2019-06-11T12:49:34Z"}}

tests/Resources/dialogs.json

@@ -11,6 +11,7 @@
     "responsible": {
       "type": "user",
       "id": 12,
+      "external_id": "12",
       "assigned_at": "2019-06-11T12:49:34.716716Z"
     },
     "is_active": true
@@ -27,6 +28,7 @@
     "responsible": {
       "type": "user",
       "id": 12,
+      "external_id": "12",
       "assigned_at": "2019-06-11T08:40:14.136916Z"
     },
     "is_active": true
@@ -43,6 +45,7 @@
     "responsible": {
       "type": "user",
       "id": 12,
+      "external_id": "12",
       "assigned_at": "2019-06-11T08:40:14Z"
     },
     "is_active": true

tests/Resources/templates.json

@@ -0,0 +1,56 @@
+[
+  {
+    "id": 1,
+    "code": "test1#ru",
+    "channel_id": 1,
+    "name": "test1",
+    "enabled": true,
+    "type": "media",
+    "template": [
+      "test1Template"
+    ],
+    "body": "test1Template",
+    "lang": "ru",
+    "category": "marketing",
+    "verification_status": "approved",
+    "header": {
+      "content": {
+        "type": "video"
+      }
+    }
+  },
+  {
+    "id": 2,
+    "code": "test2#ru",
+    "channel_id": 5,
+    "name": "test2",
+    "enabled": true,
+    "type": "media",
+    "template": [
+      "Вы не завершили покупку на нашем сайте.\n",
+      {
+        "var": "custom"
+      },
+      "Пройдите по ссылке чтобы оформить заказ."
+    ],
+    "body": "Вы не завершили покупку на нашем сайте.\n{{1}}Пройдите по ссылке чтобы оформить заказ.",
+    "lang": "ru",
+    "category": "marketing",
+    "verification_status": "approved",
+    "header": {
+      "content": {
+        "body": "Товары в вашей корзине ждут вас!",
+        "type": "text"
+      }
+    },
+    "buttons": {
+      "items": [
+        {
+          "label": "Перейти в корзину",
+          "url": "https://test-url/{{1}}",
+          "type": "url"
+        }
+      ]
+    }
+  }
+]