Bot API 7.0 - Giveaway

Author: TiiFuchs

src/Entities/Giveaway/Giveaway.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Longman\TelegramBot\Entities\Giveaway;
+
+use Longman\TelegramBot\Entities\Chat;
+use Longman\TelegramBot\Entities\Entity;
+
+/**
+ * This object represents a message about a scheduled giveaway.
+ *
+ * @link https://core.telegram.org/bots/api#giveaway
+ *
+ * @method array<Chat>   getChats()                         The list of chats which the user must join to participate in the giveaway
+ * @method int           getWinnersSelectionDate()          Point in time (Unix timestamp) when winners of the giveaway will be selected
+ * @method int           getWinnerCount()                   The number of users which are supposed to be selected as winners of the giveaway
+ * @method bool          getOnlyNewMembers()                Optional. True, if only users who join the chats after the giveaway started should be eligible to win
+ * @method bool          getHasPublicWinners()              Optional. True, if the list of giveaway winners will be visible to everyone
+ * @method string        getPrizeDescription()              Optional. Description of additional giveaway prize
+ * @method array<string> getCountryCodes()                  Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
+ * @method int           getPremiumSubscriptionMonthCount() Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
+
+ *
+ */
+class Giveaway extends Entity
+{
+
+    protected function subEntities(): array
+    {
+        return [
+            'chats' => [Chat::class],
+        ];
+    }
+
+}

src/Entities/Giveaway/GiveawayCompleted.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Longman\TelegramBot\Entities\Giveaway;
+
+use Longman\TelegramBot\Entities\Entity;
+use Longman\TelegramBot\Entities\Message;
+
+/**
+ * This object represents a service message about the completion of a giveaway without public winners.
+ *
+ * @link https://core.telegram.org/bots/api#giveawaycompleted
+ *
+ * @method int     getWinnerCount()         Number of winners in the giveaway
+ * @method int     getUnclaimedPrizeCount() Optional. Number of undistributed prizes
+ * @method Message getGiveawayMessage()     Optional. Message with the giveaway that was completed, if it wasn't deleted
+ */
+class GiveawayCompleted extends Entity
+{
+
+    protected function subEntities(): array
+    {
+        return [
+            'giveaway_message' => Message::class,
+        ];
+    }
+}

src/Entities/Giveaway/GiveawayCreated.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Longman\TelegramBot\Entities\Giveaway;
+
+use Longman\TelegramBot\Entities\Entity;
+
+class GiveawayCreated extends  Entity
+{
+
+}

src/Entities/Giveaway/GiveawayWinners.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Longman\TelegramBot\Entities\Giveaway;
+
+use Longman\TelegramBot\Entities\Chat;
+use Longman\TelegramBot\Entities\Entity;
+use Longman\TelegramBot\Entities\User;
+
+/**
+ * This object represents a message about the completion of a giveaway with public winners.
+ *
+ * @link https://core.telegram.org/bots/api#giveawaywinners
+ *
+ * @method Chat        getChat()                          The chat that created the giveaway
+ * @method int         getGiveawayMessageId()             Identifier of the message with the giveaway in the chat
+ * @method int         getWinnersSelectionDate()          Point in time (Unix timestamp) when winners of the giveaway were selected
+ * @method int         getWinnerCount()                   Total number of winners in the giveaway
+ * @method array<User> getWinners()                       List of up to 100 winners of the giveaway
+ * @method int         getAdditionalChatCount()           Optional. The number of other chats the user had to join in order to be eligible for the giveaway
+ * @method int         getPremiumSubscriptionMonthCount() Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
+ * @method int         getUnclaimedPrizeCount()           Optional. Number of undistributed prizes
+ * @method bool        getOnlyNewMembers()                Optional. True, if only users who had joined the chats after the giveaway started were eligible to win
+ * @method bool        getWasRefunded()                   Optional. True, if the giveaway was canceled because the payment for it was refunded
+ * @method string      getPrizeDescription()              Optional. Description of additional giveaway prize
+ */
+class GiveawayWinners extends Entity
+{
+
+    protected function subEntities(): array
+    {
+        return [
+            'chat' => Chat::class,
+            'winners' => [User::class],
+        ];
+    }
+}

src/Entities/Message.php

@@ -12,6 +12,10 @@
 namespace Longman\TelegramBot\Entities;
 
 use Longman\TelegramBot\Entities\Games\Game;
+use Longman\TelegramBot\Entities\Giveaway\Giveaway;
+use Longman\TelegramBot\Entities\Giveaway\GiveawayCompleted;
+use Longman\TelegramBot\Entities\Giveaway\GiveawayCreated;
+use Longman\TelegramBot\Entities\Giveaway\GiveawayWinners;
 use Longman\TelegramBot\Entities\Message\Factory as MaybeInaccessibleMessageFactory;
 use Longman\TelegramBot\Entities\Message\MaybeInaccessibleMessage;
 use Longman\TelegramBot\Entities\MessageOrigin\Factory as MessageOriginFactory;
@@ -96,6 +100,10 @@
  * @method ForumTopicReopened                     getForumTopicReopened()                     Optional. Service message: forum topic reopened
  * @method GeneralForumTopicHidden                getGeneralForumTopicHidden()                Optional. Service message: the 'General' forum topic hidden
  * @method GeneralForumTopicUnhidden              getGeneralForumTopicUnhidden()              Optional. Service message: the 'General' forum topic unhidden
+ * @method GiveawayCreated                        getGiveawayCreated()                        Optional. Service message: a scheduled giveaway was created
+ * @method Giveaway                               getGiveaway()                               Optional. The message is a scheduled giveaway message
+ * @method GiveawayWinners                        getGiveawayWinners()                        Optional. A giveaway with public winners was completed
+ * @method GiveawayCompleted                      getGiveawayCompleted()                      Optional. Service message: a giveaway without public winners was completed
  * @method VideoChatScheduled                     getVideoChatScheduled()                     Optional. Service message: voice chat scheduled
  * @method VideoChatStarted                       getVideoChatStarted()                       Optional. Service message: voice chat started
  * @method VideoChatEnded                         getVideoChatEnded()                         Optional. Service message: voice chat ended
@@ -155,6 +163,10 @@ protected function subEntities(): array
             'forum_topic_reopened'              => ForumTopicReopened::class,
             'general_forum_topic_hidden'        => GeneralForumTopicHidden::class,
             'general_forum_topic_unhidden'      => GeneralForumTopicUnhidden::class,
+            'giveaway_created'                  => GiveawayCreated::class,
+            'giveaway'                          => Giveaway::class,
+            'giveaway_winners'                  => GiveawayWinners::class,
+            'giveaway_completed'                => GiveawayCompleted::class,
             'video_chat_scheduled'              => VideoChatScheduled::class,
             'video_chat_started'                => VideoChatStarted::class,
             'video_chat_ended'                  => VideoChatEnded::class,