typescript-telegram-bot-api
Version:
Telegram Bot API wrapper for Node.js written in TypeScript
104 lines (103 loc) • 4.18 kB
TypeScript
import { Currencies, LabeledPrice } from './';
/**
* ## InputInvoiceMessageContent
* Represents the content of an invoice message to be sent as the result of an inline query.
* @see https://core.telegram.org/bots/api#inputinvoicemessagecontent
*/
export type InputInvoiceMessageContent = {
/**
* Product name, 1-32 characters
*/
title: string;
/**
* Product description, 1-255 characters
*/
description: string;
/**
* Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal
* processes.
*/
payload: string;
/**
* Optional. 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: Currencies | 'XTR';
/**
* 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[];
/**
* Optional. 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](https://t.me/BotNews/90).
*/
max_tip_amount?: number;
/**
* Optional. A JSON-serialized 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.
*/
suggested_tip_amounts?: number[];
/**
* Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider.
* A detailed description of the required fields should be provided by the payment provider.
*/
provider_data?: string;
/**
* Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
*/
photo_url?: string;
/**
* Optional. Photo size in bytes
*/
photo_size?: number;
/**
* Optional. Photo width
*/
photo_width?: number;
/**
* Optional. Photo height
*/
photo_height?: number;
/**
* Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
need_name?: boolean;
/**
* Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
need_phone_number?: boolean;
/**
* Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
need_email?: boolean;
/**
* Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
need_shipping_address?: boolean;
/**
* Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
send_phone_number_to_provider?: boolean;
/**
* Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
send_email_to_provider?: boolean;
/**
* Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
* [Telegram Stars](https://t.me/BotNews/90).
*/
is_flexible?: boolean;
};