class

Tourmaline::InputInvoiceMessageContent

Inherits JSON::Serializable / Reference / Object

Represents the content of an invoice message to be sent as the result of an inline query.

Constructors

new(title : String, description : String, payload : String, provider_token : String, currency : String, prices : Array(Tourmaline::LabeledPrice) = [] of Tourmaline::LabeledPrice, max_tip_amount : Int32 | Int64 | Nil = nil, suggested_tip_amounts : Array(Int32 | Int64) = [] of Int32 | Int64, provider_data : String | Nil = nil, photo_url : String | Nil = nil, photo_size : Int32 | Int64 | Nil = nil, photo_width : Int32 | Int64 | Nil = nil, photo_height : Int32 | Int64 | Nil = nil, need_name : Bool | Nil = nil, need_phone_number : Bool | Nil = nil, need_email : Bool | Nil = nil, need_shipping_address : Bool | Nil = nil, send_phone_number_to_provider : Bool | Nil = nil, send_email_to_provider : Bool | Nil = nil, is_flexible : Bool | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

currency

Three-letter ISO 4217 currency code, see more on currencies

Source
currency=(currency : String)

Three-letter ISO 4217 currency code, see more on currencies

Source
description

Product description, 1-255 characters

Source
description=(description : String)

Product description, 1-255 characters

Source
is_flexible=(is_flexible : Bool | Nil)

Optional. Pass True if the final price depends on the shipping method

Source
is_flexible?

Optional. Pass True if the final price depends on the shipping method

Source
max_tip_amount

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

Source
max_tip_amount=(max_tip_amount : Int32 | Int64 | Nil)

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

Source
need_email=(need_email : Bool | Nil)

Optional. Pass True if you require the user's email address to complete the order

Source
need_email?

Optional. Pass True if you require the user's email address to complete the order

Source
need_name=(need_name : Bool | Nil)

Optional. Pass True if you require the user's full name to complete the order

Source
need_name?

Optional. Pass True if you require the user's full name to complete the order

Source
need_phone_number=(need_phone_number : Bool | Nil)

Optional. Pass True if you require the user's phone number to complete the order

Source
need_phone_number?

Optional. Pass True if you require the user's phone number to complete the order

Source
need_shipping_address=(need_shipping_address : Bool | Nil)

Optional. Pass True if you require the user's shipping address to complete the order

Source
need_shipping_address?

Optional. Pass True if you require the user's shipping address to complete the order

Source
payload

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

Source
payload=(payload : String)

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

Source
photo_height

Optional. Photo height

Source
photo_height=(photo_height : Int32 | Int64 | Nil)

Optional. Photo height

Source
photo_size

Optional. Photo size in bytes

Source
photo_size=(photo_size : Int32 | Int64 | Nil)

Optional. Photo size in bytes

Source
photo_url

Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

Source
photo_url=(photo_url : String | Nil)

Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

Source
photo_width

Optional. Photo width

Source
photo_width=(photo_width : Int32 | Int64 | Nil)

Optional. Photo width

Source
prices

Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

Source
prices=(prices : Array(Tourmaline::LabeledPrice))

Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

Source
provider_data

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.

Source
provider_data=(provider_data : String | Nil)

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.

Source
provider_token

Payment provider token, obtained via @BotFather

Source
provider_token=(provider_token : String)

Payment provider token, obtained via @BotFather

Source
send_email_to_provider=(send_email_to_provider : Bool | Nil)

Optional. Pass True if the user's email address should be sent to provider

Source
send_email_to_provider?

Optional. Pass True if the user's email address should be sent to provider

Source
send_phone_number_to_provider=(send_phone_number_to_provider : Bool | Nil)

Optional. Pass True if the user's phone number should be sent to provider

Source
send_phone_number_to_provider?

Optional. Pass True if the user's phone number should be sent to provider

Source
suggested_tip_amounts

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.

Source
suggested_tip_amounts=(suggested_tip_amounts : Array(Int32 | Int64))

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.

Source
title

Product name, 1-32 characters

Source
title=(title : String)

Product name, 1-32 characters

Source