telegram-bot-api-nodejs 1.0.38 → 1.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +302 -35
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface SetWebHookOptions {
11
11
  max_connections?: number;
12
12
  allowed_updates?: AllowedUpdates[];
13
13
  }
14
- interface SendBasicOptions {
14
+ export interface SendBasicOptions {
15
15
  chat_id: number | string;
16
16
  business_connection_id?: string;
17
17
  message_thread_id?: number;
@@ -25,19 +25,48 @@ export interface SendMessageOptions extends SendBasicOptions {
25
25
  disable_web_page_preview?: boolean;
26
26
  entities?: MessageEntity[];
27
27
  }
28
- interface SendAnimationOptions extends SendBasicOptions {
28
+ export interface SendAnimationOptions extends SendBasicOptions {
29
29
  animation: string;
30
30
  parse_mode?: ParseMode;
31
31
  caption?: string;
32
32
  }
33
- interface SendDocumentOptions extends SendBasicOptions {
33
+ export interface SendDocumentOptions extends SendBasicOptions {
34
34
  document: string;
35
35
  parse_mode?: ParseMode;
36
36
  caption?: string;
37
37
  }
38
- interface SendMediaGroupOptions extends SendBasicOptions {
38
+ export interface SendMediaGroupOptions extends SendBasicOptions {
39
39
  media: Array<InputMediaAudio | InputMediaDocument | InputMediaPhoto | InputMediaVideo>;
40
40
  }
41
+ export interface SendInvoiceOptions extends SendBasicOptions {
42
+ provider_data?: string;
43
+ photo_url?: string;
44
+ photo_size?: number;
45
+ photo_width?: number;
46
+ photo_height?: number;
47
+ need_name?: boolean;
48
+ need_phone_number?: boolean;
49
+ need_email?: boolean;
50
+ need_shipping_address?: boolean;
51
+ is_flexible?: boolean;
52
+ }
53
+ export interface RestrictChatMemberOptions {
54
+ until_date?: number;
55
+ can_send_messages?: boolean;
56
+ can_send_media_messages?: boolean;
57
+ can_send_other_messages?: boolean;
58
+ can_add_web_page_previews?: boolean;
59
+ }
60
+ export interface PromoteChatMemberOptions {
61
+ can_change_info?: boolean;
62
+ can_post_messages?: boolean;
63
+ can_edit_messages?: boolean;
64
+ can_delete_messages?: boolean;
65
+ can_invite_users?: boolean;
66
+ can_restrict_members?: boolean;
67
+ can_pin_messages?: boolean;
68
+ can_promote_members?: boolean;
69
+ }
41
70
  export interface AnswerCallbackQueryOptions {
42
71
  callback_query_id: string;
43
72
  text?: string;
@@ -45,33 +74,55 @@ export interface AnswerCallbackQueryOptions {
45
74
  url?: string;
46
75
  cache_time?: number;
47
76
  }
48
- interface SetMyCommandsOptions {
77
+ export interface SetMyCommandsOptions {
49
78
  commands: BotCommand[];
50
79
  scope?: BotCommandScope;
51
80
  language_code?: string;
52
81
  }
53
- interface GetMyCommandsOptions {
82
+ export interface GetMyCommandsOptions {
54
83
  scope?: BotCommandScope;
55
84
  language_code?: string;
56
85
  }
57
- interface DeleteMyCommandsOptions {
86
+ export interface DeleteMyCommandsOptions {
58
87
  }
59
- interface EditMessageTextOptions extends EditMessageReplyMarkupOptions {
88
+ export interface EditMessageTextOptions extends EditMessageReplyMarkupOptions {
60
89
  parse_mode?: ParseMode;
61
90
  disable_web_page_preview?: boolean;
62
91
  text: string;
63
92
  }
64
- interface EditMessageReplyMarkupOptions {
93
+ export interface EditMessageCaptionOptions extends EditMessageReplyMarkupOptions {
94
+ reply_markup?: InlineKeyboardMarkup;
95
+ }
96
+ export interface EditMessageReplyMarkupOptions {
65
97
  chat_id?: number | string;
66
98
  message_id?: number | string;
67
99
  inline_message_id?: string;
68
100
  }
69
- interface PassportFile {
101
+ export interface SetGameScoreOptions {
102
+ force?: boolean;
103
+ disable_edit_message?: boolean;
104
+ chat_id?: number;
105
+ message_id?: number;
106
+ inline_message_id?: string;
107
+ }
108
+ export interface GetGameHighScoresOptions {
109
+ chat_id?: number;
110
+ message_id?: number;
111
+ inline_message_id?: string;
112
+ }
113
+ export interface AnswerShippingQueryOptions {
114
+ shipping_options?: ShippingOption[];
115
+ error_message?: string;
116
+ }
117
+ export interface AnswerPreCheckoutQueryOptions {
118
+ error_message?: string;
119
+ }
120
+ export interface PassportFile {
70
121
  file_id: string;
71
122
  file_size: number;
72
123
  file_date: number;
73
124
  }
74
- interface EncryptedPassportElement {
125
+ export interface EncryptedPassportElement {
75
126
  type: string;
76
127
  data?: string;
77
128
  phone_number?: string;
@@ -83,12 +134,12 @@ interface EncryptedPassportElement {
83
134
  translation?: PassportFile[];
84
135
  hash: string;
85
136
  }
86
- interface EncryptedCredentials {
137
+ export interface EncryptedCredentials {
87
138
  data: string;
88
139
  hash: string;
89
140
  secret: string;
90
141
  }
91
- interface PassportData {
142
+ export interface PassportData {
92
143
  data: EncryptedPassportElement[];
93
144
  credentials: EncryptedCredentials;
94
145
  }
@@ -155,12 +206,12 @@ export interface Chat {
155
206
  can_set_sticker_set?: boolean;
156
207
  sticker_set_name?: string;
157
208
  }
158
- interface ForumTopicCreated {
209
+ export interface ForumTopicCreated {
159
210
  name: string;
160
211
  icon_color: number;
161
212
  icon_custom_emoji_id?: string;
162
213
  }
163
- interface ForumTopicEdited {
214
+ export interface ForumTopicEdited {
164
215
  name?: string;
165
216
  icon_custom_emoji_id?: string;
166
217
  }
@@ -320,7 +371,7 @@ export interface MessageEntity {
320
371
  url?: string;
321
372
  user?: User;
322
373
  }
323
- interface FileBase {
374
+ export interface FileBase {
324
375
  file_id: string;
325
376
  file_size?: number;
326
377
  }
@@ -382,7 +433,7 @@ export interface Voice extends FileBase {
382
433
  duration: number;
383
434
  mime_type?: string;
384
435
  }
385
- interface InputMediaBase {
436
+ export interface InputMediaBase {
386
437
  media: string;
387
438
  caption?: string;
388
439
  parse_mode?: ParseMode;
@@ -464,18 +515,18 @@ export interface UserProfilePhotos {
464
515
  export interface File extends FileBase {
465
516
  file_path?: string;
466
517
  }
467
- interface ReplyKeyboardMarkup {
518
+ export interface ReplyKeyboardMarkup {
468
519
  keyboard: KeyboardButton[][];
469
520
  resize_keyboard?: boolean;
470
521
  one_time_keyboard?: boolean;
471
522
  selective?: boolean;
472
523
  }
473
- interface KeyboardButton {
524
+ export interface KeyboardButton {
474
525
  text: string;
475
526
  request_contact?: boolean;
476
527
  request_location?: boolean;
477
528
  }
478
- interface ReplyKeyboardRemove {
529
+ export interface ReplyKeyboardRemove {
479
530
  remove_keyboard: boolean;
480
531
  selective?: boolean;
481
532
  }
@@ -492,7 +543,7 @@ export interface InlineKeyboardButton {
492
543
  callback_game?: CallbackGame;
493
544
  pay?: boolean;
494
545
  }
495
- interface LoginUrl {
546
+ export interface LoginUrl {
496
547
  url: string;
497
548
  forward_text?: string;
498
549
  bot_username?: string;
@@ -507,17 +558,17 @@ export interface CallbackQuery {
507
558
  data?: string;
508
559
  game_short_name?: string;
509
560
  }
510
- interface ForceReply {
561
+ export interface ForceReply {
511
562
  force_reply: boolean;
512
563
  selective?: boolean;
513
564
  }
514
- interface ChatPhoto {
565
+ export interface ChatPhoto {
515
566
  small_file_id: string;
516
567
  small_file_unique_id: string;
517
568
  big_file_id: string;
518
569
  big_file_unique_id: string;
519
570
  }
520
- interface ChatMember {
571
+ export interface ChatMember {
521
572
  user: User;
522
573
  status: ChatMemberStatus;
523
574
  until_date?: number;
@@ -537,7 +588,7 @@ interface ChatMember {
537
588
  can_send_other_messages?: boolean;
538
589
  can_add_web_page_previews?: boolean;
539
590
  }
540
- interface ChatPermissions {
591
+ export interface ChatPermissions {
541
592
  can_send_messages?: boolean;
542
593
  can_send_media_messages?: boolean;
543
594
  can_send_polls?: boolean;
@@ -559,26 +610,237 @@ export interface Sticker {
559
610
  mask_position?: MaskPosition;
560
611
  file_size?: number;
561
612
  }
562
- interface MaskPosition {
613
+ export interface StickerSet {
614
+ name: string;
615
+ title: string;
616
+ contains_masks: boolean;
617
+ stickers: Sticker[];
618
+ }
619
+ export interface MaskPosition {
563
620
  point: string;
564
621
  x_shift: number;
565
622
  y_shift: number;
566
623
  scale: number;
567
624
  }
568
- interface InlineQuery {
625
+ export interface InlineQuery {
569
626
  id: string;
570
627
  from: User;
571
628
  location?: Location;
572
629
  query: string;
573
630
  offset: string;
574
631
  }
575
- interface ChosenInlineResult {
632
+ export interface InlineQueryResultBase {
633
+ id: string;
634
+ reply_markup?: InlineKeyboardMarkup;
635
+ }
636
+ export interface InlineQueryResultArticle extends InlineQueryResultBase {
637
+ type: "article";
638
+ title: string;
639
+ input_message_content: InputMessageContent;
640
+ url?: string;
641
+ hide_url?: boolean;
642
+ description?: string;
643
+ thumb_url?: string;
644
+ thumb_width?: number;
645
+ thumb_height?: number;
646
+ }
647
+ export interface InlineQueryResultPhoto extends InlineQueryResultBase {
648
+ type: "photo";
649
+ photo_url: string;
650
+ thumb_url: string;
651
+ photo_width?: number;
652
+ photo_height?: number;
653
+ title?: string;
654
+ description?: string;
655
+ caption?: string;
656
+ input_message_content?: InputMessageContent;
657
+ }
658
+ export interface InlineQueryResultGif extends InlineQueryResultBase {
659
+ type: "gif";
660
+ gif_url: string;
661
+ gif_width?: number;
662
+ gif_height?: number;
663
+ gif_duration?: number;
664
+ thumb_url?: string;
665
+ title?: string;
666
+ caption?: string;
667
+ input_message_content?: InputMessageContent;
668
+ }
669
+ export interface InlineQueryResultMpeg4Gif extends InlineQueryResultBase {
670
+ type: "mpeg4_gif";
671
+ mpeg4_url: string;
672
+ mpeg4_width?: number;
673
+ mpeg4_height?: number;
674
+ mpeg4_duration?: number;
675
+ thumb_url?: string;
676
+ title?: string;
677
+ caption?: string;
678
+ input_message_content?: InputMessageContent;
679
+ }
680
+ export interface InlineQueryResultVideo extends InlineQueryResultBase {
681
+ type: "video";
682
+ video_url: string;
683
+ mime_type: string;
684
+ thumb_url: string;
685
+ title: string;
686
+ caption?: string;
687
+ video_width?: number;
688
+ video_height?: number;
689
+ video_duration?: number;
690
+ description?: string;
691
+ input_message_content?: InputMessageContent;
692
+ }
693
+ export interface InlineQueryResultAudio extends InlineQueryResultBase {
694
+ type: "audio";
695
+ audio_url: string;
696
+ title: string;
697
+ caption?: string;
698
+ performer?: string;
699
+ audio_duration?: number;
700
+ input_message_content?: InputMessageContent;
701
+ }
702
+ export interface InlineQueryResultVoice extends InlineQueryResultBase {
703
+ type: "voice";
704
+ voice_url: string;
705
+ title: string;
706
+ caption?: string;
707
+ voice_duration?: number;
708
+ input_message_content?: InputMessageContent;
709
+ }
710
+ export interface InlineQueryResultDocument extends InlineQueryResultBase {
711
+ type: "document";
712
+ title: string;
713
+ caption?: string;
714
+ document_url: string;
715
+ mime_type: string;
716
+ description?: string;
717
+ input_message_content?: InputMessageContent;
718
+ thumb_url?: string;
719
+ thumb_width?: number;
720
+ thumb_height?: number;
721
+ }
722
+ export interface InlineQueryResultLocationBase extends InlineQueryResultBase {
723
+ latitude: number;
724
+ longitude: number;
725
+ title: string;
726
+ input_message_content?: InputMessageContent;
727
+ thumb_url?: string;
728
+ thumb_width?: number;
729
+ thumb_height?: number;
730
+ }
731
+ export interface InlineQueryResultLocation extends InlineQueryResultLocationBase {
732
+ type: "location";
733
+ }
734
+ export interface InlineQueryResultVenue extends InlineQueryResultLocationBase {
735
+ type: "venue";
736
+ address: string;
737
+ foursquare_id?: string;
738
+ }
739
+ export interface InlineQueryResultContact extends InlineQueryResultBase {
740
+ type: "contact";
741
+ phone_number: string;
742
+ first_name: string;
743
+ last_name?: string;
744
+ input_message_content?: InputMessageContent;
745
+ thumb_url?: string;
746
+ thumb_width?: number;
747
+ thumb_height?: number;
748
+ }
749
+ export interface InlineQueryResultGame extends InlineQueryResultBase {
750
+ type: "game";
751
+ game_short_name: string;
752
+ }
753
+ export interface InlineQueryResultCachedPhoto extends InlineQueryResultBase {
754
+ type: "photo";
755
+ photo_file_id: string;
756
+ title?: string;
757
+ description?: string;
758
+ caption?: string;
759
+ input_message_content?: InputMessageContent;
760
+ }
761
+ export interface InlineQueryResultCachedGif extends InlineQueryResultBase {
762
+ type: "gif";
763
+ gif_file_id: string;
764
+ title?: string;
765
+ caption?: string;
766
+ input_message_content?: InputMessageContent;
767
+ }
768
+ export interface InlineQueryResultCachedMpeg4Gif extends InlineQueryResultBase {
769
+ type: "mpeg4_gif";
770
+ mpeg4_file_id: string;
771
+ title?: string;
772
+ caption?: string;
773
+ input_message_content?: InputMessageContent;
774
+ }
775
+ export interface InlineQueryResultCachedSticker extends InlineQueryResultBase {
776
+ type: "sticker";
777
+ sticker_file_id: string;
778
+ input_message_content?: InputMessageContent;
779
+ }
780
+ export interface InlineQueryResultCachedDocument extends InlineQueryResultBase {
781
+ type: "document";
782
+ title: string;
783
+ document_file_id: string;
784
+ description?: string;
785
+ caption?: string;
786
+ input_message_content?: InputMessageContent;
787
+ }
788
+ export interface InlineQueryResultCachedVideo extends InlineQueryResultBase {
789
+ type: "video";
790
+ video_file_id: string;
791
+ title: string;
792
+ description?: string;
793
+ caption?: string;
794
+ input_message_content?: InputMessageContent;
795
+ }
796
+ export interface InlineQueryResultCachedVoice extends InlineQueryResultBase {
797
+ type: "voice";
798
+ voice_file_id: string;
799
+ title: string;
800
+ caption?: string;
801
+ input_message_content?: InputMessageContent;
802
+ }
803
+ export interface InlineQueryResultCachedAudio extends InlineQueryResultBase {
804
+ type: "audio";
805
+ audio_file_id: string;
806
+ caption?: string;
807
+ input_message_content?: InputMessageContent;
808
+ }
809
+ type InputMessageContent = object;
810
+ export interface InputTextMessageContent extends InputMessageContent {
811
+ message_text: string;
812
+ parse_mode?: ParseMode;
813
+ disable_web_page_preview?: boolean;
814
+ }
815
+ export interface InputLocationMessageContent extends InputMessageContent {
816
+ latitude: number;
817
+ longitude: number;
818
+ }
819
+ export interface InputVenueMessageContent extends InputLocationMessageContent {
820
+ title: string;
821
+ address: string;
822
+ foursquare_id?: string;
823
+ }
824
+ export interface InputContactMessageContent extends InputMessageContent {
825
+ phone_number: string;
826
+ first_name: string;
827
+ last_name?: string;
828
+ }
829
+ export interface ChosenInlineResult {
576
830
  result_id: string;
577
831
  from: User;
578
832
  location?: Location;
579
833
  inline_message_id?: string;
580
834
  query: string;
581
835
  }
836
+ export interface ResponseParameters {
837
+ migrate_to_chat_id?: number;
838
+ retry_after?: number;
839
+ }
840
+ export interface LabeledPrice {
841
+ label: string;
842
+ amount: number;
843
+ }
582
844
  export interface Invoice {
583
845
  title: string;
584
846
  description: string;
@@ -586,7 +848,7 @@ export interface Invoice {
586
848
  currency: string;
587
849
  total_amount: number;
588
850
  }
589
- interface ShippingAddress {
851
+ export interface ShippingAddress {
590
852
  country_code: string;
591
853
  state: string;
592
854
  city: string;
@@ -594,16 +856,21 @@ interface ShippingAddress {
594
856
  street_line2: string;
595
857
  post_code: string;
596
858
  }
597
- interface OrderInfo {
859
+ export interface OrderInfo {
598
860
  name?: string;
599
861
  phone_number?: string;
600
862
  email?: string;
601
863
  shipping_address?: ShippingAddress;
602
864
  }
603
- interface MessageAutoDeleteTimerChanged {
865
+ export interface MessageAutoDeleteTimerChanged {
604
866
  message_auto_delete_time: number;
605
867
  }
606
- interface SuccessfulPayment {
868
+ export interface ShippingOption {
869
+ id: string;
870
+ title: string;
871
+ prices: LabeledPrice[];
872
+ }
873
+ export interface SuccessfulPayment {
607
874
  currency: string;
608
875
  total_amount: number;
609
876
  invoice_payload: string;
@@ -612,13 +879,13 @@ interface SuccessfulPayment {
612
879
  telegram_payment_charge_id: string;
613
880
  provider_payment_charge_id: string;
614
881
  }
615
- interface ShippingQuery {
882
+ export interface ShippingQuery {
616
883
  id: string;
617
884
  from: User;
618
885
  invoice_payload: string;
619
886
  shipping_address: ShippingAddress;
620
887
  }
621
- interface PreCheckoutQuery {
888
+ export interface PreCheckoutQuery {
622
889
  id: string;
623
890
  from: User;
624
891
  currency: string;
@@ -627,7 +894,7 @@ interface PreCheckoutQuery {
627
894
  shipping_option_id?: string;
628
895
  order_info?: OrderInfo;
629
896
  }
630
- interface ChatMemberUpdated {
897
+ export interface ChatMemberUpdated {
631
898
  chat: Chat;
632
899
  from: User;
633
900
  date: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "telegram-bot-api-nodejs",
3
- "version": "1.0.38",
3
+ "version": "1.0.39",
4
4
  "description": "Telegram Bot API client for nodejs",
5
5
  "type": "module",
6
6
  "main": "index.js",