/
messages.py
1300 lines (1146 loc) · 47.5 KB
/
messages.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Generated with love
import typing
from vkbottle.types import responses
from .access import APIAccessibility
from .method import BaseMethod
class MessagesAddChatUser(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(
self, chat_id: int, user_id: int = None
) -> responses.ok_response.OkResponse:
""" messages.addChatUser
From Vk Docs: Adds a new user to a chat.
Access from user token(s)
:param chat_id: Chat ID.
:param user_id: ID of the user to be added to the chat.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.addChatUser",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesAllowMessagesFromGroup(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(
self, group_id: int, key: str = None
) -> responses.ok_response.OkResponse:
""" messages.allowMessagesFromGroup
From Vk Docs: Allows sending messages from community to the current user.
Access from user token(s)
:param group_id: Group ID.
:param key:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.allowMessagesFromGroup",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesCreateChat(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(
self, user_ids: typing.List = None, title: str = None,
) -> responses.messages.CreateChat:
""" messages.createChat
From Vk Docs: Creates a chat with several participants.
Access from user token(s)
:param user_ids: IDs of the users to be added to the chat.
:param title: Chat title.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.createChat",
params,
response_model=responses.messages.CreateChatModel,
)
class MessagesDelete(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
message_ids: typing.List = None,
spam: bool = None,
group_id: int = None,
delete_for_all: bool = None,
) -> responses.ok_response.OkResponse:
""" messages.delete
From Vk Docs: Deletes one or more messages.
Access from user, group token(s)
:param message_ids: Message IDs.
:param spam: '1' — to mark message as spam.
:param group_id: Group ID (for group messages with user access token)
:param delete_for_all: '1' — delete message for for all.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.delete",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesDeleteChatPhoto(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, chat_id: int, group_id: int = None
) -> responses.messages.DeleteChatPhoto:
""" messages.deleteChatPhoto
From Vk Docs: Deletes a chat's cover picture.
Access from user, group token(s)
:param chat_id: Chat ID.
:param group_id:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.deleteChatPhoto",
params,
response_model=responses.messages.DeleteChatPhotoModel,
)
class MessagesDeleteConversation(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, user_id: int = None, peer_id: int = None, group_id: int = None
) -> responses.messages.DeleteConversation:
""" messages.deleteConversation
From Vk Docs: Deletes all private messages in a conversation.
Access from user, group token(s)
:param user_id: User ID. To clear a chat history use 'chat_id'
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param group_id: Group ID (for group messages with user access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.deleteConversation",
params,
response_model=responses.messages.DeleteConversationModel,
)
class MessagesDenyMessagesFromGroup(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(self, group_id: int) -> responses.ok_response.OkResponse:
""" messages.denyMessagesFromGroup
From Vk Docs: Denies sending message from community to the current user.
Access from user token(s)
:param group_id: Group ID.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.denyMessagesFromGroup",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesEdit(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
peer_id: int,
message_id: int,
message: str = None,
lat: typing.Any = None,
long: typing.Any = None,
attachment: str = None,
keep_forward_messages: bool = None,
keep_snippets: bool = None,
group_id: int = None,
dont_parse_links: bool = None,
) -> responses.messages.Edit:
""" messages.edit
From Vk Docs: Edits the message.
Access from user, group token(s)
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param message: (Required if 'attachments' is not set.) Text of the message.
:param message_id:
:param lat: Geographical latitude of a check-in, in degrees (from -90 to 90).
:param long: Geographical longitude of a check-in, in degrees (from -180 to 180).
:param attachment: (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "<owner_id>_<media_id>", '' — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '<owner_id>' — ID of the media attachment owner. '<media_id>' — media attachment ID. Example: "photo100172_166443618"
:param keep_forward_messages: '1' — to keep forwarded, messages.
:param keep_snippets: '1' — to keep attached snippets.
:param group_id: Group ID (for group messages with user access token)
:param dont_parse_links:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.edit", params, response_model=responses.messages.EditModel
)
class MessagesEditChat(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, chat_id: int, title: str
) -> responses.ok_response.OkResponse:
""" messages.editChat
From Vk Docs: Edits the title of a chat.
Access from user, group token(s)
:param chat_id: Chat ID.
:param title: New title of the chat.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.editChat",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesGetByConversationMessageId(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
peer_id: int,
conversation_message_ids: typing.List,
extended: bool = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.GetByConversationMessageId:
""" messages.getByConversationMessageId
From Vk Docs: Returns messages by their IDs within the conversation.
Access from user, group token(s)
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param conversation_message_ids: Conversation message IDs.
:param extended: Information whether the response should be extended
:param fields: Profile fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getByConversationMessageId",
params,
response_model=responses.messages.GetByConversationMessageIdModel,
)
class MessagesGetById(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
message_ids: typing.List,
preview_length: int = None,
extended: bool = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.GetById:
""" messages.getById
From Vk Docs: Returns messages by their IDs.
Access from user, group token(s)
:param message_ids: Message IDs.
:param preview_length: Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
:param extended: Information whether the response should be extended
:param fields: Profile fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getById", params, response_model=responses.messages.GetByIdModel
)
class MessagesGetChatPreview(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(
self, peer_id: int = None, link: str = None, fields: typing.List = None
) -> responses.messages.GetChatPreview:
""" messages.getChatPreview
From Vk Docs:
Access from user token(s)
:param peer_id:
:param link: Invitation link.
:param fields: Profile fields to return.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getChatPreview",
params,
response_model=responses.messages.GetChatPreviewModel,
)
class MessagesGetConversationMembers(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, peer_id: int, fields: typing.List = None, group_id: int = None
) -> responses.messages.GetConversationMembers:
""" messages.getConversationMembers
From Vk Docs: Returns a list of IDs of users participating in a chat.
Access from user, group token(s)
:param peer_id: Peer ID.
:param fields: Profile fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getConversationMembers",
params,
response_model=responses.messages.GetConversationMembersModel,
)
class MessagesGetConversations(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
offset: int = None,
count: int = None,
filter: str = None,
extended: bool = None,
start_message_id: int = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.GetConversations:
""" messages.getConversations
From Vk Docs: Returns a list of the current user's conversations.
Access from user, group token(s)
:param offset: Offset needed to return a specific subset of conversations.
:param count: Number of conversations to return.
:param filter: Filter to apply: 'all' — all conversations, 'unread' — conversations with unread messages, 'important' — conversations, marked as important (only for community messages), 'unanswered' — conversations, marked as unanswered (only for community messages)
:param extended: '1' — return extra information about users and communities
:param start_message_id: ID of the message from what to return dialogs.
:param fields: Profile and communities fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getConversations",
params,
response_model=responses.messages.GetConversationsModel,
)
class MessagesGetConversationsById(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
peer_ids: typing.List,
extended: bool = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.GetConversationsById:
""" messages.getConversationsById
From Vk Docs: Returns conversations by their IDs
Access from user, group token(s)
:param peer_ids: Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param extended: Return extended properties
:param fields: Profile and communities fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getConversationsById",
params,
response_model=responses.messages.GetConversationsByIdModel,
)
class MessagesGetHistory(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
offset: int = None,
count: int = None,
user_id: int = None,
peer_id: int = None,
start_message_id: int = None,
rev: int = None,
extended: bool = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.GetHistory:
""" messages.getHistory
From Vk Docs: Returns message history for the specified user or group chat.
Access from user, group token(s)
:param offset: Offset needed to return a specific subset of messages.
:param count: Number of messages to return.
:param user_id: ID of the user whose message history you want to return.
:param peer_id:
:param start_message_id: Starting message ID from which to return history.
:param rev: Sort order: '1' — return messages in chronological order. '0' — return messages in reverse chronological order.
:param extended: Information whether the response should be extended
:param fields: Profile fields to return.
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getHistory",
params,
response_model=responses.messages.GetHistoryModel,
)
class MessagesGetHistoryAttachments(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
peer_id: int,
media_type: str = None,
start_from: str = None,
count: int = None,
photo_sizes: bool = None,
fields: typing.List = None,
group_id: int = None,
preserve_order: bool = None,
max_forwards_level: int = None,
) -> responses.messages.GetHistoryAttachments:
""" messages.getHistoryAttachments
From Vk Docs: Returns media files from the dialog or group chat.
Access from user, group token(s)
:param peer_id: Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"
:param media_type: Type of media files to return: *'photo',, *'video',, *'audio',, *'doc',, *'link'.,*'market'.,*'wall'.,*'share'
:param start_from: Message ID to start return results from.
:param count: Number of objects to return.
:param photo_sizes: '1' — to return photo sizes in a
:param fields: Additional profile [vk.com/dev/fields|fields] to return.
:param group_id: Group ID (for group messages with group access token)
:param preserve_order:
:param max_forwards_level:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getHistoryAttachments",
params,
response_model=responses.messages.GetHistoryAttachmentsModel,
)
class MessagesGetInviteLink(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, peer_id: int, reset: bool = None, group_id: int = None
) -> responses.messages.GetInviteLink:
""" messages.getInviteLink
From Vk Docs:
Access from user, group token(s)
:param peer_id: Destination ID.
:param reset: 1 — to generate new link (revoke previous), 0 — to return previous link.
:param group_id: Group ID
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getInviteLink",
params,
response_model=responses.messages.GetInviteLinkModel,
)
class MessagesGetLastActivity(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(self, user_id: int) -> responses.messages.GetLastActivity:
""" messages.getLastActivity
From Vk Docs: Returns a user's current status and date of last activity.
Access from user token(s)
:param user_id: User ID.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getLastActivity",
params,
response_model=responses.messages.GetLastActivityModel,
)
class MessagesGetLongPollHistory(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
ts: int = None,
pts: int = None,
preview_length: int = None,
onlines: bool = None,
fields: typing.List = None,
events_limit: int = None,
msgs_limit: int = None,
max_msg_id: int = None,
group_id: int = None,
lp_version: int = None,
last_n: int = None,
credentials: bool = None,
) -> responses.messages.GetLongPollHistory:
""" messages.getLongPollHistory
From Vk Docs: Returns updates in user's private messages.
Access from user, group token(s)
:param ts: Last value of the 'ts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
:param pts: Lsat value of 'pts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
:param preview_length: Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
:param onlines: '1' — to return history with online users only.
:param fields: Additional profile [vk.com/dev/fields|fields] to return.
:param events_limit: Maximum number of events to return.
:param msgs_limit: Maximum number of messages to return.
:param max_msg_id: Maximum ID of the message among existing ones in the local copy. Both messages received with API methods (for example, , ), and data received from a Long Poll server (events with code 4) are taken into account.
:param group_id: Group ID (for group messages with user access token)
:param lp_version:
:param last_n:
:param credentials:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getLongPollHistory",
params,
response_model=responses.messages.GetLongPollHistoryModel,
)
class MessagesGetLongPollServer(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, need_pts: bool = None, group_id: int = None, lp_version: int = None
) -> responses.messages.GetLongPollServer:
""" messages.getLongPollServer
From Vk Docs: Returns data required for connection to a Long Poll server.
Access from user, group token(s)
:param need_pts: '1' — to return the 'pts' field, needed for the [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
:param group_id: Group ID (for group messages with user access token)
:param lp_version: Long poll version
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.getLongPollServer",
params,
response_model=responses.messages.GetLongPollServerModel,
)
class MessagesIsMessagesFromGroupAllowed(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, group_id: int, user_id: int
) -> responses.messages.IsMessagesFromGroupAllowed:
""" messages.isMessagesFromGroupAllowed
From Vk Docs: Returns information whether sending messages from the community to current user is allowed.
Access from user, group token(s)
:param group_id: Group ID.
:param user_id: User ID.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.isMessagesFromGroupAllowed",
params,
response_model=responses.messages.IsMessagesFromGroupAllowedModel,
)
class MessagesJoinChatByInviteLink(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(self, link: str) -> responses.messages.JoinChatByInviteLink:
""" messages.joinChatByInviteLink
From Vk Docs:
Access from user token(s)
:param link: Invitation link.
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.joinChatByInviteLink",
params,
response_model=responses.messages.JoinChatByInviteLinkModel,
)
class MessagesMarkAsAnsweredConversation(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, peer_id: int, answered: bool = None, group_id: int = None
) -> responses.ok_response.OkResponse:
""" messages.markAsAnsweredConversation
From Vk Docs: Marks and unmarks conversations as unanswered.
Access from user, group token(s)
:param peer_id: ID of conversation to mark as important.
:param answered: '1' — to mark as answered, '0' — to remove the mark
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.markAsAnsweredConversation",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesMarkAsImportant(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [APIAccessibility.USER]
async def __call__(
self, message_ids: typing.List = None, important: int = None
) -> responses.messages.MarkAsImportant:
""" messages.markAsImportant
From Vk Docs: Marks and unmarks messages as important (starred).
Access from user token(s)
:param message_ids: IDs of messages to mark as important.
:param important: '1' — to add a star (mark as important), '0' — to remove the star
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.markAsImportant",
params,
response_model=responses.messages.MarkAsImportantModel,
)
class MessagesMarkAsImportantConversation(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, peer_id: int, important: bool = None, group_id: int = None
) -> responses.ok_response.OkResponse:
""" messages.markAsImportantConversation
From Vk Docs: Marks and unmarks conversations as important.
Access from user, group token(s)
:param peer_id: ID of conversation to mark as important.
:param important: '1' — to add a star (mark as important), '0' — to remove the star
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.markAsImportantConversation",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesMarkAsRead(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
message_ids: typing.List = None,
peer_id: int = None,
start_message_id: int = None,
group_id: int = None,
) -> responses.ok_response.OkResponse:
""" messages.markAsRead
From Vk Docs: Marks messages as read.
Access from user, group token(s)
:param message_ids: IDs of messages to mark as read.
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param start_message_id: Message ID to start from.
:param group_id: Group ID (for group messages with user access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.markAsRead",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesPin(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, peer_id: int, message_id: int = None
) -> responses.messages.Pin:
""" messages.pin
From Vk Docs: Pin a message.
Access from user, group token(s)
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
:param message_id:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.pin", params, response_model=responses.messages.PinModel
)
class MessagesRemoveChatUser(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, chat_id: int, user_id: int = None, member_id: int = None
) -> responses.ok_response.OkResponse:
""" messages.removeChatUser
From Vk Docs: Allows the current user to leave a chat or, if the current user started the chat, allows the user to remove another user from the chat.
Access from user, group token(s)
:param chat_id: Chat ID.
:param user_id: ID of the user to be removed from the chat.
:param member_id:
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.removeChatUser",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesRestore(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self, message_id: int, group_id: int = None
) -> responses.ok_response.OkResponse:
""" messages.restore
From Vk Docs: Restores a deleted message.
Access from user, group token(s)
:param message_id: ID of a previously-deleted message to restore.
:param group_id: Group ID (for group messages with user access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()
if k not in ["self"] and v is not None
}
return await self.request(
"messages.restore",
params,
response_model=responses.ok_response.OkResponseModel,
)
class MessagesSearch(BaseMethod):
kwargs: dict = {}
access_token_type: APIAccessibility = [
APIAccessibility.USER,
APIAccessibility.GROUP,
]
async def __call__(
self,
q: str = None,
peer_id: int = None,
date: int = None,
preview_length: int = None,
offset: int = None,
count: int = None,
extended: bool = None,
fields: typing.List = None,
group_id: int = None,
) -> responses.messages.Search:
""" messages.search
From Vk Docs: Returns a list of the current user's private messages that match search criteria.
Access from user, group token(s)
:param q: Search query string.
:param peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
:param date: Date to search message before in Unixtime.
:param preview_length: Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
:param offset: Offset needed to return a specific subset of messages.
:param count: Number of messages to return.
:param extended:
:param fields:
:param group_id: Group ID (for group messages with group access token)
"""
params = {
k if not k.endswith("_") else k[:-1]: v
for k, v in {**locals(), **self.kwargs}.items()