#42 readme, changelog, docs and some fixes. temporaily disabled phpcd

Author: greenplugin

CHANGELOG.md

@@ -2,9 +2,9 @@
 
 All notable changes to `telegram-bot-api` will be documented in this file.
 
+<!--- 
 Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
-<!--- 
 ## NEXT - YYYY-MM-DD
 
 ### Added
@@ -23,6 +23,109 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Nothing
 --->
 
+## 1.7.0 - 2020-12-12
+#### Bot API 5.0 - november November 4, 2020 
+
+### Added
+- #### Run Your Own Bot API Server Usage
+    - You can pass url as 4th param in bot api
+         ```php 
+         $bot = new \TgBotApi\BotApiBase\BotApi('<bot key>', $apiClient, new \TgBotApi\BotApiBase\BotApiNormalizer(), '<your-domain>');
+         ```
+    - Added the method `logOut` (`LogOutMethod`), which can be used to log out from the cloud Bot API server before launching your bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive all updates.
+    - Added the method `close` (`CloseMethod`), which can be used to close the bot instance before moving it from one local server to another.
+    
+- #### Webhooks
+    - Added the parameter `ipAddress` to the class `SetWebhookMethod`, allowing to bypass DNS resolving and use the specified fixed IP address to send webhook requests.
+    - Added the field `ipAddress` to the class `WebhookInfoType`, containing the current IP address used for webhook connections creation.
+    - Added the ability to drop all pending updates when changing webhook URL using the parameter `dropPendingUpdates` to the class `SetWebhookMethod` and to `DeleteWebhookMethod`.
+
+- #### Working with Groups
+    - The `getChat` request now returns the identifier of the linked chat for supergroups and channels, i.e. the discussion group identifier for a channel and vice versa in the `linkedChatId` property.
+    - The `getChat` request now returns the location to which the supergroup is connected (see `ChatType::$location`). Added the class `ChatLocationType` to represent the location.
+    - Added the parameter `onlyIfBanned` to the class `UnbanChatMemberMethod` to allow safe unban.
+
+- #### Working with Files
+    - Added the property `fileName` to the classes `AudioType` and `VideoType`, containing the name of the original file.
+    -  Added the ability to disable server-side file content type detection using the property `disableContentTypeDetection` in the `SendDocumentMethod` and the class inputMediaDocument.
+
+- #### Multiple Pinned Messages
+    - Added the parameter `messageId` to the `UnpinChatMessageMethod` to allow unpinning of the specific pinned message.
+    - Added the method `UnpinAllChatMessagesMethod`, which can be used to unpin all pinned messages in a chat.
+
+- #### File Albums
+    - Added support for sending and receiving audio and document albums in the `SendMediaGroupMethod`. 
+
+- #### Live Locations
+    - Added the field `livePeriod` to the class `LocationType`, representing a maximum period for which the live location can be updated.
+    - Added support for live location heading: added the field `heading` to the classes `LocationType`, `InlineQueryResultLocationType`, `InputLocationMessageContentType`, `SendLocationMethod` and `EditMessageLiveLocationMethod`.
+    - Added support for proximity alerts in live locations: added the field `proximityAlertRadius` to the classes `LocationType`, `InlineQueryResultLocationType`, `InputLocationMessageContentType`, `SendLocationMethod` and `EditMessageLiveLocationMethod`.
+    - Added the type `ProximityAlertTriggered` and the field `proximityAlertTriggered` to the class Message.
+    - Added possibility to specify the horizontal accuracy of a location. Added the field `horizontalAccuracy` to the classes `LocationType`, `InlineQueryResultLocationType`, `InputLocationMessageContentType`, `SendLocationMethod` and `EditMessageLiveLocationMethod`.
+
+- #### Anonymous Admins
+    - Added the field `senderChat` to the class `MessageType`, containing the sender of a message which is a chat (group or channel). For backward compatibility in non-channel chats, the field from in such messages will contain the user 777000 for messages automatically forwarded to the discussion group and the user 1087968824 (@GroupAnonymousBot) for messages from anonymous group administrators.
+    - Added the field `isAnonymous` to the class `ChatMemberType`, which can be used to distinguish anonymous chat administrators.
+    - Added the parameter `isAnonymous` to the `PromoteChatMemberMethod`, which allows to promote anonymous chat administrators. The bot itself should have the `isAnonymous` right to do this. Despite the fact that bots can have the `isAnonymous` right, they will never appear as anonymous in the chat. Bots can use the right only for passing to other administrators.
+    - Added the custom title of an anonymous message sender to the class `MessageType` as `authorSignature`.
+
+- #### And More
+    - Added the method `BotApi::copyMessage` and `CopyMessageMethod`, which sends a copy of any message.
+    - Maximum poll question length increased to 300.
+    - Added the ability to manually specify text entities (property `entities` or `captionEntities`) instead of specifying the `parseMode` in the classes 
+        - `InputMediaPhotoType`
+        - `InputMediaVideoType` 
+        - `InputMediaAnimationType`
+        - `InputMediaAudioType`
+        - `InputMediaDocumentType`
+        - `InlineQueryResultPhotoType`
+        - `InlineQueryResultGifType`
+        - `InlineQueryResultMpeg4GifType`
+        - `InlineQueryResultVideoType` 
+        - `InlineQueryResultAudioType` 
+        - `InlineQueryResultVoiceType` 
+        - `InlineQueryResultDocumentType` 
+        - `InlineQueryResultCachedPhotoType` 
+        - `InlineQueryResultCachedGifType` 
+        - `InlineQueryResultCachedMpeg4GifType` 
+        - `InlineQueryResultCachedVideoType` 
+        - `InlineQueryResultCachedAudioType` 
+        - `InlineQueryResultCachedVoiceType`
+        - `InlineQueryResultCachedDocumentType` 
+        - `InputTextMessageContentType` 
+        - `SendMessageMethod`
+        - `SendPhotoMethod`
+        - `SendVideoMethod`
+        - `SendAnimationMethod` 
+        - `SendAudioMethod`
+        - `SendDocumentMethod` 
+        - `SendVoiceMethod`
+        - `SendPollMethod` 
+        - `EditMessageTextMethod` 
+        - `EditMessageCaptionMethod`
+    - Added the fields `googlePlaceId` and `googlePlaceType` to the classes `VenueType`, `InlineQueryResultVenueType`, `InputVenueMessageContentType` and to the methods `SendVenueMethod` to support Google Places as a venue API provider.
+    - Added the field `allowSendingWithoutReply` to allow sending messages not a as reply if the replied-to message has already been deleted to following classes:
+        - `sendMessageMethod`
+        - `sendPhotoMethod`
+        - `sendVideoMethod`
+        - `SendAnimationMethod`
+        - `SendAudioMethod`
+        - `SendDocumentMethod`
+        - `SendStickerMethod`
+        - `SendVideoNoteMethod`
+        - `SendVoiceMethod`
+        - `SendLocationMethod`
+        - `SendVenueMethod`
+        - `SendContactMethod`
+        - `SendPollMethod`
+        - `SendDiceMethod`
+        - `SendInvoiceMethod`
+        - `SendGameMethod`
+        - `SendMediaGroupMethod`
+    
+- #### And Last but bot Least
+    - Supported the new football and slot machine animations for the random dice. Choose between different animations (dice, darts, basketball, football, slot machine) by specifying the emoji parameter in the method sendDice.
+
 ## 1.6.2 - 2020-07-13
 
 ### Fixed

README.md

@@ -14,7 +14,7 @@
 [![Duplicated Lines (%)][sonar-duplicated-lines-icon]][sonar-path]
 [![Security Rating][sonar-security-rating-icon]][sonar-path]
 
-#### Supported Telegram Bot API v4.9 (June 4, 2020)
+#### Supported Telegram Bot API 5.0 (November 4, 2020)
 
 ## Installation
 
@@ -58,41 +58,44 @@ $bot = new \TgBotApi\BotApiBase\BotApi('<bot key>', $apiClient, new \TgBotApi\Bo
 
 |Method|Allowed type|response|
 |:--|:--|:--|
-|add|AddStickerToSetMethod|bool|
-|answer|AnswerCallbackQueryMethod, AnswerInlineQueryMethod, AnswerPreCheckoutQueryMethod, AnswerShippingQueryMethod|bool|
-|create|CreateNewStickerSetMethod|bool|
-|delete|DeleteChatPhotoMethod, DeleteChatStickerSetMethod, DeleteMessageMethod, DeleteStickerFromSetMethod, DeleteWebhookMethod|bool|
-|edit|EditMessageCaptionMethod, EditMessageLiveLocationMethod, EditMessageMediaMethod, EditMessageReplyMarkupMethod, EditMessageTextMethod|bool|
-|forward|ForwardMessageMethod|MessageType|
-|kick|KickChatMemberMethod|bool|
-|leave|LeaveChatMethod|bool|
-|pin|PinChatMessageMethod|bool|
-|promote|PromoteChatMemberMethod|bool|
-|restrict|RestrictChatMemberMethod|bool|
-|send|SendPhotoMethod, SendAudioMethod, SendDocumentMethod, SendVideoMethod, SendAnimationMethod, SendVoiceMethod, SendVideoNoteMethod, SendGameMethod, SendInvoiceMethod, SendLocationMethod, SendVenueMethod, SendContactMethod, SendStickerMethod, SendMessageMethod, SendPollMethod, SendDiceMethod|MessageType|
-|set|SetChatDescriptionMethod, SetChatPhotoMethod, SetChatStickerSetMethod, SetChatTitleMethod, SetGameScoreMethod, SetStickerPositionInSetMethod, SetWebhookMethod, SetPassportDataErrorsMethod, SetChatPermissionsMethod, SetChatAdministratorCustomTitleMethod, SetMyCommandMethod, SetStickerSetThumbMethod|bool|
-|stop|StopMessageLiveLocationMethod|bool|
-|stopPoll|StopPollMethod|Poll|
-|unban|UnbanChatMemberMethod|bool|
-|unpin|UnpinChatMessageMethod|bool|
-|upload|UploadStickerFileMethod|FileType|
-|exportChatInviteLink|ExportChatInviteLinkMethod|string|
-|sendChatAction|SendChatActionMethod|bool|
-|getUpdates|GetUpdatesMethod|UpdateType[]|
-|getMe|GetMeMethod|UserType|
-|getMyCommands|GetMyCommandsMethod|BotCommandType|
-|getUserProfilePhotos|GetUserProfilePhotosMethod|UserProfilePhotosType|
-|getWebhookInfo|GetWebhookInfoMethod|WebhookInfoType|
-|getChatMembersCount|GetChatMembersCountMethod|int|
-|getChat|GetChatMethod|ChatType|
-|getChatAdministrators|GetChatAdministratorsMethod|ChatMemberType[]|
-|getChatMember|GetChatMemberMethod|ChatMemberType|
-|getGameHighScores|GetGameHighScoresMethod|GameHighScoreType[]|
-|getStickerSet|GetStickerSetMethod|StickerSetType|
-|getFile|GetFileMethod|FileType|
-|sendMediaGroup|SendMediaGroupMethod|MessageType[]|
-|getAbsoluteFilePath|FileType|string|
-|call($method, [string $type])|any method class, [optional expected type]|array or excepted type object|
+|`add`|AddStickerToSetMethod|bool|
+|`answer`|AnswerCallbackQueryMethod, AnswerInlineQueryMethod, AnswerPreCheckoutQueryMethod, AnswerShippingQueryMethod|bool|
+|`create`|CreateNewStickerSetMethod|bool|
+|`delete`|DeleteChatPhotoMethod, DeleteChatStickerSetMethod, DeleteMessageMethod, DeleteStickerFromSetMethod, DeleteWebhookMethod|bool|
+|`edit`|EditMessageCaptionMethod, EditMessageLiveLocationMethod, EditMessageMediaMethod, EditMessageReplyMarkupMethod, EditMessageTextMethod|bool|
+|`forward`|ForwardMessageMethod|MessageType|
+|`kick`|KickChatMemberMethod|bool|
+|`leave`|LeaveChatMethod|bool|
+|`pin`|PinChatMessageMethod|bool|
+|`promote`|PromoteChatMemberMethod|bool|
+|`restrict`|RestrictChatMemberMethod|bool|
+|`send`|SendPhotoMethod, SendAudioMethod, SendDocumentMethod, SendVideoMethod, SendAnimationMethod, SendVoiceMethod, SendVideoNoteMethod, SendGameMethod, SendInvoiceMethod, SendLocationMethod, SendVenueMethod, SendContactMethod, SendStickerMethod, SendMessageMethod, SendPollMethod, SendDiceMethod|MessageType|
+|`set`|SetChatDescriptionMethod, SetChatPhotoMethod, SetChatStickerSetMethod, SetChatTitleMethod, SetGameScoreMethod, SetStickerPositionInSetMethod, SetWebhookMethod, SetPassportDataErrorsMethod, SetChatPermissionsMethod, SetChatAdministratorCustomTitleMethod, SetMyCommandMethod, SetStickerSetThumbMethod|bool|
+|`stop`|StopMessageLiveLocationMethod|bool|
+|`stopPoll`|StopPollMethod|Poll|
+|`unban`|UnbanChatMemberMethod|bool|
+|`unpin`|UnpinChatMessageMethod, UnpinAllChatMessagesMethod|bool|
+|`upload`|UploadStickerFileMethod|FileType|
+|`exportChatInviteLink`|ExportChatInviteLinkMethod|string|
+|`sendChatAction`|SendChatActionMethod|bool|
+|`getUpdates`|GetUpdatesMethod|UpdateType[]|
+|`getMe`|GetMeMethod|UserType|
+|`getMyCommands`|GetMyCommandsMethod|BotCommandType|
+|`getUserProfilePhotos`|GetUserProfilePhotosMethod|UserProfilePhotosType|
+|`getWebhookInfo`|GetWebhookInfoMethod|WebhookInfoType|
+|`getChatMembersCount`|GetChatMembersCountMethod|int|
+|`getChat`|GetChatMethod|ChatType|
+|`getChatAdministrators`|GetChatAdministratorsMethod|ChatMemberType[]|
+|`getChatMember`|GetChatMemberMethod|ChatMemberType|
+|`getGameHighScores`|GetGameHighScoresMethod|GameHighScoreType[]|
+|`getStickerSet`|GetStickerSetMethod|StickerSetType|
+|`getFile`|GetFileMethod|FileType|
+|`sendMediaGroup`|SendMediaGroupMethod|MessageType[]|
+|`getAbsoluteFilePath`|FileType|string|
+|`logOut`|LogOutMethod|bool|
+|`close`|CloseMethod|bool|
+|`copyMessage`|CopyMessageMethod|MessageIdType|
+|`call($method, [string $type])`|any method class, [optional expected type]|array or excepted type object|
 
 Implemented all methods and types referenced by [official Api](https://core.telegram.org/bots/api)
 
@@ -152,7 +155,7 @@ If you discover any security related issues, please email wformps@gmail.com inst
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
 [ico-php-v]: https://img.shields.io/travis/php-v/tg-bot-api/bot-api-base.svg?style=flat-square
-[ico-bot-api]: https://img.shields.io/badge/Bot%20API-4.9-blue.svg?style=flat-square
+[ico-bot-api]: https://img.shields.io/badge/Bot%20API-5.0-blue.svg?style=flat-square
 [ico-version]: https://img.shields.io/packagist/v/tg-bot-api/bot-api-base.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
 [ico-travis]: https://img.shields.io/travis/tg-bot-api/bot-api-base/master.svg?style=flat-square

composer.json

@@ -40,7 +40,7 @@
     "phpstan/phpstan": "^0.10.6",
     "phpunit/phpunit": "^7.5.2",
     "povils/phpmnd": "^2.0",
-    "sebastian/phpcpd": "^4.1",
+    "sebastian/phpcpd": "^5.0",
     "squizlabs/php_codesniffer": "^3.4"
   },
   "autoload": {