Skip to content

Commit 42d3daf

Browse files
VadimSavVadimSav
committed
feat: sync SDK with API docs - add 9 new methods, update 5 existing
New methods (+ async variants): - account.getStateInstanceHistory(count) - account.updateApiToken() - serviceMethods.getChats(count) - groups.updateGroupSettings(groupId, allowParticipantsEditGroupSettings, allowParticipantsSendMessages) - journals.lastIncomingCalls(minutes) - journals.lastOutgoingCalls(minutes) - queues.getMessagesCount() - queues.getWebhooksCount() - queues.clearWebhooksQueue() Updated signatures (backward compatible): - sending.sendMessage: add typePreview, customPreview - sending.forwardMessages: add typingTime - serviceMethods.checkWhatsapp: add chatId (preferred), force; phoneNumber -> Optional - serviceMethods.getContacts: add group, count - receiving.receiveNotification: add receiveTimeout Examples: add 8 new files, update 6 existing README/docs: add new methods and examples to both tables
1 parent 73bc819 commit 42d3daf

23 files changed

Lines changed: 631 additions & 38 deletions

‎README.md‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,18 @@ asyncio.run(main())
298298
| Example of sending interactive buttons asynchronously with a reply | [SendInteractiveButtonsReplyAsync.py](../examples/async/sending/sendInteractiveButtonsReplyAsync.py) |
299299
| Example of sending a notification about typing or recording audio | [SendTyping.py](../examples/sync/sendTyping.py) |
300300
| Example of sending a notification about typing or recording audio asynchronously | [SendTypingAsync.py](../examples/async/sendTypingAsync.py) |
301+
| Example of account methods (state history, token update) | [accountMethods.py](./examples/sync/accountMethods.py) |
302+
| Example of account methods asynchronously | [accountMethodsAsync.py](./examples/async/accountMethodsAsync.py) |
303+
| Example of getting last incoming and outgoing calls | [lastCalls.py](./examples/sync/lastCalls.py) |
304+
| Example of getting last calls asynchronously | [lastCallsAsync.py](./examples/async/lastCallsAsync.py) |
305+
| Example of sending a message with link preview options | [sendMessageWithPreview.py](./examples/sync/sending/sendMessageWithPreview.py) |
306+
| Example of sending a message with link preview options asynchronously | [sendMessageWithPreviewAsync.py](./examples/async/sending/sendMessageWithPreviewAsync.py) |
307+
| Example of queues methods (counts, clear webhooks queue) | [queuesMethods.py](./examples/sync/queuesMethods.py) |
308+
| Example of queues methods asynchronously | [queuesMethodsAsync.py](./examples/async/queuesMethodsAsync.py) |
309+
| Example of groups methods (update settings) | [groupsMethods.py](./examples/sync/groupsMethods.py) |
310+
| Example of groups methods asynchronously | [groupsMethodsAsync.py](./examples/async/groupsMethodsAsync.py) |
311+
| Example of service methods (getChats, checkWhatsapp, getContacts) | [serviceMethods.py](./examples/sync/serviceMethods.py) |
312+
| Example of service methods asynchronously | [serviceMethodsAsync.py](./examples/async/serviceMethodsAsync.py) |
301313

302314
## The full list of the library methods
303315

@@ -313,6 +325,8 @@ asyncio.run(main())
313325
| `account.qr` | The method is designed to get a QR code | [QR](https://green-api.com/en/docs/api/account/QR/) |
314326
| `account.setProfilePicture` | The method is designed to set the avatar of the account | [SetProfilePicture](https://green-api.com/en/docs/api/account/SetProfilePicture/) |
315327
| `account.getAuthorizationCode` | The method is designed to authorize an instance by phone number | [GetAuthorizationCode](https://green-api.com/en/docs/api/account/GetAuthorizationCode/) |
328+
| `account.getStateInstanceHistory` | The method returns the history of the instance state changes | [GetStateInstanceHistory](https://green-api.com/en/docs/api/account/GetStateInstanceHistory/) |
329+
| `account.updateApiToken` | The method generates a new API token for the instance (beta) | [UpdateApiToken](https://green-api.com/en/docs/api/account/UpdateApiToken/) |
316330
| `contacts.addContact` | The method is used to add a number to contacts | [addContact](https://green-api.com/en/docs/api/contacts/AddContact/) |
317331
| `contacts.editContact` | The method is used to edit a number in contacts | [editContact](https://green-api.com/en/docs/api/contacts/EditContact/) |
318332
| `contacts.deleteContact` | The method is used to remove a number from contacts | [deleteContact](https://green-api.com/en/docs/api/contacts/DeleteContact/) |
@@ -326,6 +340,7 @@ asyncio.run(main())
326340
| `groups.removeAdmin` | The method deprives the participant of group chat administration rights | [RemoveAdmin](https://green-api.com/en/docs/api/groups/RemoveAdmin/) |
327341
| `groups.setGroupPicture` | The method sets the avatar of the group | [SetGroupPicture](https://green-api.com/en/docs/api/groups/SetGroupPicture/) |
328342
| `groups.leaveGroup` | The method logs the user of the current account out of the group chat | [LeaveGroup](https://green-api.com/en/docs/api/groups/LeaveGroup/) |
343+
| `groups.updateGroupSettings` | The method changes the group settings (beta) | [UpdateGroupSettings](https://green-api.com/en/docs/api/groups/UpdateGroupSettings/) |
329344
| `statuses.sendTextStatus` | The method is aimed for sending a text status | [SendTextStatus](https://green-api.com/en/docs/api/statuses/SendTextStatus/) |
330345
| `statuses.sendVoiceStatus` | The method is aimed for sending a voice status | [SendVoiceStatus](https://green-api.com/en/docs/api/statuses/SendVoiceStatus/) |
331346
| `statuses.sendMediaStatus` | The method is aimed for sending a pictures or video status | [SendMediaStatus](https://green-api.com/en/docs/api/statuses/SendMediaStatus/) |
@@ -337,8 +352,13 @@ asyncio.run(main())
337352
| `journals.getMessage` | The method returns a chat message | [GetMessage](https://green-api.com/en/docs/api/journals/GetMessage/) |
338353
| `journals.lastIncomingMessages` | The method returns the most recent incoming messages of the account | [LastIncomingMessages](https://green-api.com/en/docs/api/journals/LastIncomingMessages/) |
339354
| `journals.lastOutgoingMessages` | The method returns the last sent messages of the account | [LastOutgoingMessages](https://green-api.com/en/docs/api/journals/LastOutgoingMessages/) |
355+
| `journals.lastIncomingCalls` | The method returns the last incoming calls of the account (beta) | [LastIncomingCalls](https://green-api.com/en/docs/api/journals/LastIncomingCalls/) |
356+
| `journals.lastOutgoingCalls` | The method returns the last outgoing calls of the account (beta) | [LastOutgoingCalls](https://green-api.com/en/docs/api/journals/LastOutgoingCalls/) |
340357
| `queues.showMessagesQueue` | The method is designed to get the list of messages that are in the queue to be sent | [ShowMessagesQueue](https://green-api.com/en/docs/api/queues/ShowMessagesQueue/) |
341358
| `queues.clearMessagesQueue` | The method is designed to clear the queue of messages to be sent | [ClearMessagesQueue](https://green-api.com/en/docs/api/queues/ClearMessagesQueue/) |
359+
| `queues.getMessagesCount` | The method returns the number of messages in the outgoing queue | [GetMessagesCount](https://green-api.com/en/docs/api/queues/GetMessagesCount/) |
360+
| `queues.getWebhooksCount` | The method returns the number of notifications in the incoming webhooks queue | [GetWebhooksCount](https://green-api.com/en/docs/api/queues/GetWebhooksCount/) |
361+
| `queues.clearWebhooksQueue` | The method clears the incoming webhooks queue | [ClearWebhooksQueue](https://green-api.com/en/docs/api/queues/ClearWebhooksQueue/) |
342362
| `marking.readChat` | The method is designed to mark chat messages as read | [ReadChat](https://green-api.com/en/docs/api/marks/ReadChat/) |
343363
| `receiving.receiveNotification` | The method is designed to receive a single incoming notification from the notification queue | [ReceiveNotification](https://green-api.com/en/docs/api/receiving/technology-http-api/ReceiveNotification/) |
344364
| `receiving.deleteNotification` | The method is designed to remove an incoming notification from the notification queue | [DeleteNotification](https://green-api.com/en/docs/api/receiving/technology-http-api/DeleteNotification/) |
@@ -362,7 +382,8 @@ asyncio.run(main())
362382
| `serviceMethods.archiveChat` | The method archives the chat | [ArchiveChat](https://green-api.com/en/docs/api/service/archiveChat/) |
363383
| `serviceMethods.unarchiveChat` | The method unarchives the chat | [UnarchiveChat](https://green-api.com/en/docs/api/service/unarchiveChat/) |
364384
| `serviceMethods.setDisappearingChat` | The method is designed to change the settings of disappearing messages in chats | [SetDisappearingChat](https://green-api.com/en/docs/api/service/SetDisappearingChat/) |
365-
| `serviceMethods.sendTyping` | The method is intended to send a notification about typing or recording audio in the chat | [SendTyping](https://green-api.com/docs/api/service/SendTyping/) |
385+
| `serviceMethods.sendTyping` | The method is intended to send a notification about typing or recording audio in the chat | [SendTyping](https://green-api.com/en/docs/api/service/SendTyping/) |
386+
| `serviceMethods.getChats` | The method returns a list of chats sorted by message activity time | [GetChats](https://green-api.com/en/docs/api/service/GetChats/) |
366387
| `webhooks.startReceivingNotifications` | The method is designed to start receiving new notifications | |
367388
| `webhooks.stopReceivingNotifications` | The method is designed to stop receiving new notifications | |
368389
| `partner.GetInstances` | The method is for getting all the account instances created by the partner. | [GetInstances](https://green-api.com/en/docs/partners/getInstances/) |

0 commit comments

Comments
 (0)