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/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/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

@@ -1,5 +1,13 @@
 <?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;
@@ -22,6 +30,14 @@ class TemplateVariables implements ModelInterface
      */
     private $header;
 
+
+    /** @var array<TemplateAttachment> $attachments
+     *
+     * @Type("array")
+     * @Accessor(getter="getAttachments",setter="setAttachments")
+     */
+    private $attachments;
+
     /**
      * @var array<string, string> $body
      *
@@ -85,4 +101,20 @@ class TemplateVariables implements ModelInterface
     {
         $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

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