Merge pull request #14 from devrabie/bot-api-9.3-updates-13406599450393388176

Update Bot API to version 9.3 (including 8.3-9.2 features)

Author: devrabie

src/Entities/AcceptedGiftTypes.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class AcceptedGiftTypes
+ *
+ * This object describes the types of gifts that can be gifted to a user or a chat.
+ *
+ * @link https://core.telegram.org/bots/api#acceptedgifttypes
+ *
+ * @method bool getUnlimitedGifts()      True, if unlimited regular gifts are accepted
+ * @method bool getLimitedGifts()        True, if limited regular gifts are accepted
+ * @method bool getUniqueGifts()         True, if unique gifts or gifts that can be upgraded to unique for free are accepted
+ * @method bool getPremiumSubscription() True, if a Telegram Premium subscription is accepted
+ * @method bool getGiftsFromChannels()   True, if transfers of unique gifts from channels are accepted
+ */
+class AcceptedGiftTypes extends Entity
+{
+}

src/Entities/AffiliateInfo.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class AffiliateInfo
+ *
+ * Contains information about the affiliate that received a commission via this transaction.
+ *
+ * @link https://core.telegram.org/bots/api#affiliateinfo
+ *
+ * @method User getAffiliateUser()      Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user
+ * @method Chat getAffiliateChat()      Optional. The chat that received an affiliate commission if it was received by a chat
+ * @method int  getCommissionPerMille() The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users
+ * @method int  getAmount()             Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds
+ * @method int  getNanostarAmount()     Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds
+ */
+class AffiliateInfo extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'affiliate_user' => User::class,
+            'affiliate_chat' => Chat::class,
+        ];
+    }
+}

src/Entities/BusinessBotRights.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class BusinessBotRights
+ *
+ * Represents the rights of a business bot.
+ *
+ * @link https://core.telegram.org/bots/api#businessbotrights
+ *
+ * @method bool getCanReply()                    Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours
+ * @method bool getCanReadMessages()             Optional. True, if the bot can mark incoming private messages as read
+ * @method bool getCanDeleteSentMessages()       Optional. True, if the bot can delete messages sent by the bot
+ * @method bool getCanDeleteAllMessages()        Optional. True, if the bot can delete all private messages in managed chats
+ * @method bool getCanEditName()                 Optional. True, if the bot can edit the first and last name of the business account
+ * @method bool getCanEditBio()                  Optional. True, if the bot can edit the bio of the business account
+ * @method bool getCanEditProfilePhoto()         Optional. True, if the bot can edit the profile photo of the business account
+ * @method bool getCanEditUsername()             Optional. True, if the bot can edit the username of the business account
+ * @method bool getCanChangeGiftSettings()       Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account
+ * @method bool getCanViewGiftsAndStars()        Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
+ * @method bool getCanConvertGiftsToStars()      Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars
+ * @method bool getCanTransferAndUpgradeGifts()  Optional. True, if the bot can transfer and upgrade gifts owned by the business account
+ * @method bool getCanTransferStars()            Optional. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts
+ * @method bool getCanManageStories()            Optional. True, if the bot can post, edit and delete stories on behalf of the business account
+ */
+class BusinessBotRights extends Entity
+{
+}

src/Entities/BusinessConnection.php

@@ -23,8 +23,18 @@
  * @method int    getDate()         Date the connection was established in Unix time
  * @method bool   getCanReply()     True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours
  * @method bool   getIsEnabled()    True, if the business connection is active
+ * @method BusinessBotRights getRights() Optional. Rights of the business bot
  */
 class BusinessConnection extends Entity
 {
-
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'user'   => User::class,
+            'rights' => BusinessBotRights::class,
+        ];
+    }
 }

src/Entities/Chat.php

@@ -28,6 +28,7 @@
  * @method string          getFirstName()                          Optional. First name of the other party in a private chat
  * @method string          getLastName()                           Optional. Last name of the other party in a private chat
  * @method bool            getIsForum()                            Optional. True, if the supergroup chat is a forum (has topics enabled)
+ * @method bool            getIsDirectMessages()                   Optional. True, if the chat is the direct messages chat of a channel
  * @method int             getAccentColorId()                      Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.
  * @method ChatPhoto       getPhoto()                              Optional. Chat photo. Returned only in getChat.
  * @method string[]        getActiveUsernames()                    Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.

src/Entities/ChatAdministratorRights.php

@@ -20,6 +20,7 @@
  * @method bool getCanEditStories()      Optional. True, if the administrator can edit stories posted by other users; channels only
  * @method bool getCanDeleteStories()    Optional. True, if the administrator can delete stories posted by other users; channels only
  * @method bool getCanManageTopics()     Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
+ * @method bool getCanManageDirectMessages() Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
  *
  * @method $this setIsAnonymous(bool $is_anonymous)                   True, if the user's presence in the chat is hidden
  * @method $this setCanManageChat(bool $can_manage_chat)              True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
@@ -36,6 +37,7 @@
  * @method $this setCanEditStories(bool $can_edit_stories)            Optional. True, if the administrator can edit stories posted by other users; channels only
  * @method $this setCanDeleteStories(bool $can_delete_stories)        Optional. True, if the administrator can delete stories posted by other users; channels only
  * @method $this setCanManageTopics(bool $can_manage_topics)          Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
+ * @method $this setCanManageDirectMessages(bool $can_manage_direct_messages) Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
  */
 class ChatAdministratorRights extends Entity
 {

src/Entities/ChatFullInfo.php

@@ -33,8 +33,14 @@
  * @method bool            getCanSetStickerSet()                   Optional. True, if the bot can change the group sticker set. Returned only in getChat.
  * @method string          getCustomEmojiStickerSetName()          Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.
  * @method int             getLinkedChatId()                       Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. Returned only in getChat.
+ * @method Chat            getParentChat()                         Optional. Information about the corresponding channel chat; for direct messages chats only
  * @method ChatLocation    getLocation()                           Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.
+ * @method UserRating      getRating()                             Optional. For private chats, the rating of the user if any
+ * @method UniqueGiftColors getUniqueGiftColors()                  Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
  * @method int             getMaxReactionCount()                   Optional. The maximum number of reactions that can be set on a message in the chat
+ * @method AcceptedGiftTypes getAcceptedGiftTypes()                Optional. Information about types of gifts that are accepted by the chat or by the corresponding user for private chats
+ * @method bool            getCanSendPaidMedia()                   Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
+ * @method int             getPaidMessageStarCount()               Optional. The number of Telegram Stars a general user have to pay to send a message to the chat
  */
 class ChatFullInfo extends Chat
 {
@@ -44,11 +50,10 @@ class ChatFullInfo extends Chat
     protected function subEntities(): array
     {
         return array_merge(parent::subEntities(), [
-            // Properties already defined in Chat.php and handled by its subEntities are inherited.
-            // Add or override here if ChatFullInfo has different types or new sub-entities.
-            // For example, if PinnedMessage in ChatFullInfo could be a different class than in Chat,
-            // or if new properties in ChatFullInfo are entities themselves.
-            // Based on the current structure, most of these are already covered by Chat.php
+            'parent_chat'         => Chat::class,
+            'rating'              => UserRating::class,
+            'unique_gift_colors'  => UniqueGiftColors::class,
+            'accepted_gift_types' => AcceptedGiftTypes::class,
         ]);
     }
 }

src/Entities/ChatMember/ChatMemberAdministrator.php

@@ -28,6 +28,7 @@
  * @method bool   getCanEditStories()      Optional. True, if the administrator can edit stories posted by other users; channels only
  * @method bool   getCanDeleteStories()    Optional. True, if the administrator can delete stories posted by other users; channels only
  * @method bool   getCanManageTopics()     Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
+ * @method bool   getCanManageDirectMessages() Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
  * @method string getCustomTitle()         Custom title for this user
  */
 class ChatMemberAdministrator extends Entity implements ChatMember

src/Entities/Checklist.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class Checklist
+ *
+ * Describes a checklist.
+ *
+ * @link https://core.telegram.org/bots/api#checklist
+ *
+ * @method string          getTitle()                       Title of the checklist
+ * @method MessageEntity[] getTitleEntities()               Optional. Special entities that appear in the checklist title
+ * @method ChecklistTask[] getTasks()                       List of tasks in the checklist
+ * @method bool            getOthersCanAddTasks()           Optional. True, if users other than the creator of the list can add tasks to the list
+ * @method bool            getOthersCanMarkTasksAsDone()    Optional. True, if users other than the creator of the list can mark tasks as done or not done
+ */
+class Checklist extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'title_entities' => [MessageEntity::class],
+            'tasks'          => [ChecklistTask::class],
+        ];
+    }
+}

src/Entities/ChecklistTask.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class ChecklistTask
+ *
+ * Describes a task in a checklist.
+ *
+ * @link https://core.telegram.org/bots/api#checklisttask
+ *
+ * @method int             getId()              Unique identifier of the task
+ * @method string          getText()            Text of the task
+ * @method MessageEntity[] getTextEntities()    Optional. Special entities that appear in the task text
+ * @method User            getCompletedByUser() Optional. User that completed the task; omitted if the task wasn't completed by a user
+ * @method Chat            getCompletedByChat() Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
+ * @method int             getCompletionDate()  Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
+ */
+class ChecklistTask extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'text_entities'     => [MessageEntity::class],
+            'completed_by_user' => User::class,
+            'completed_by_chat' => Chat::class,
+        ];
+    }
+}