@grammyjs/types
Advanced tools
@grammyjs/types - npm Package Compare versions
Comparing version 3.7.0 to 3.8.0
@@ -89,2 +89,4 @@ import type { Chat, User } from "./manage.js"; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the photo caption. See formatting options for more details. */ | ||
@@ -121,2 +123,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the caption. See formatting options for more details. */ | ||
@@ -153,2 +157,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the caption. See formatting options for more details. */ | ||
@@ -181,2 +187,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the video caption. See formatting options for more details. */ | ||
@@ -392,2 +400,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the photo caption. See formatting options for more details. */ | ||
@@ -414,2 +424,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the caption. See formatting options for more details. */ | ||
@@ -436,2 +448,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the caption. See formatting options for more details. */ | ||
@@ -496,2 +510,4 @@ parse_mode?: ParseMode; | ||
| caption?: string; | ||
| /** Pass True, if the caption must be shown above the message media */ | ||
| show_caption_above_media?: boolean; | ||
| /** Mode for parsing entities in the video caption. See formatting options for more details. */ | ||
@@ -618,9 +634,9 @@ parse_mode?: ParseMode; | ||
| payload: string; | ||
| /** Payment provider token, obtained via BotFather */ | ||
| provider_token: string; | ||
| /** Three-letter ISO 4217 currency code, see more on currencies */ | ||
| /** Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. */ | ||
| provider_token?: string; | ||
| /** Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. */ | ||
| currency: string; | ||
| /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */ | ||
| /** Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. */ | ||
| prices: LabeledPrice[]; | ||
| /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 */ | ||
| /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. */ | ||
| max_tip_amount?: number; | ||
@@ -639,15 +655,15 @@ /** An array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. */ | ||
| photo_height?: number; | ||
| /** Pass True if you require the user's full name to complete the order */ | ||
| /** Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. */ | ||
| need_name?: boolean; | ||
| /** Pass True if you require the user's phone number to complete the order */ | ||
| /** Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. */ | ||
| need_phone_number?: boolean; | ||
| /** Pass True if you require the user's email address to complete the order */ | ||
| /** Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. */ | ||
| need_email?: boolean; | ||
| /** Pass True if you require the user's shipping address to complete the order */ | ||
| /** Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. */ | ||
| need_shipping_address?: boolean; | ||
| /** Pass True if the user's phone number should be sent to provider */ | ||
| /** Pass True if the user's phone number should be sent to provider. Ignored for payments in Telegram Stars. */ | ||
| send_phone_number_to_provider?: boolean; | ||
| /** Pass True if the user's email address should be sent to provider */ | ||
| /** Pass True if the user's email address should be sent to provider. Ignored for payments in Telegram Stars. */ | ||
| send_email_to_provider?: boolean; | ||
| /** Pass True if the final price depends on the shipping method */ | ||
| /** Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. */ | ||
| is_flexible?: boolean; | ||
@@ -654,0 +670,0 @@ } |
| import type { ChatAdministratorRights, User } from "./manage.js"; | ||
| import type { MaybeInaccessibleMessage } from "./message.js"; | ||
| /** This object represents an inline keyboard that appears right next to the message it belongs to. */ | ||
| /** This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button. */ | ||
| export interface InlineKeyboardMarkup { | ||
@@ -50,3 +50,3 @@ /** Array of button rows, each represented by an Array of InlineKeyboardButton objects */ | ||
| interface PayButton extends AbstractInlineKeyboardButton { | ||
| /** Specify True, to send a Pay button. | ||
| /** Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon. | ||
@@ -155,3 +155,3 @@ NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. */ | ||
| } | ||
| /** This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive. */ | ||
| /** This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text. */ | ||
| export type KeyboardButton = KeyboardButton.CommonButton | KeyboardButton.RequestUsersButton | KeyboardButton.RequestChatButton | KeyboardButton.RequestContactButton | KeyboardButton.RequestLocationButton | KeyboardButton.RequestPollButton | KeyboardButton.WebAppButton | string; | ||
@@ -158,0 +158,0 @@ /** This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. */ |
| { | ||
| "name": "@grammyjs/types", | ||
| "version": "3.7.0", | ||
| "version": "3.8.0", | ||
| "description": "Telegram Bot API type declarations for grammY", | ||
@@ -5,0 +5,0 @@ "main": "mod.js", |
@@ -17,3 +17,3 @@ import type { User } from "./manage.js"; | ||
| start_parameter: string; | ||
| /** Three-letter ISO 4217 currency code */ | ||
| /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */ | ||
| currency: string; | ||
@@ -60,3 +60,3 @@ /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */ | ||
| export interface SuccessfulPayment { | ||
| /** Three-letter ISO 4217 currency code */ | ||
| /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */ | ||
| currency: string; | ||
@@ -93,3 +93,3 @@ /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */ | ||
| from: User; | ||
| /** Three-letter ISO 4217 currency code */ | ||
| /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */ | ||
| currency: string; | ||
@@ -96,0 +96,0 @@ /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */ |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.92%
347472
- Lines of code
- increased by1.62%
5255