Skip to content

class Tourmaline::InputInvoiceMessageContent
inherits Reference #

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

Included modules

JSON::Serializable

Constructors#

.new(title, description, payload, provider_token, currency, 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, photo_url : String? = nil, photo_size : Int32 | Int64 | Nil = nil, photo_width : Int32 | Int64 | Nil = nil, photo_height : Int32 | Int64 | Nil = nil, need_name : Bool? = nil, need_phone_number : Bool? = nil, need_email : Bool? = nil, need_shipping_address : Bool? = nil, send_phone_number_to_provider : Bool? = nil, send_email_to_provider : Bool? = nil, is_flexible : Bool? = nil) #

View source

.new(pull : JSON::PullParser) #

View source

Methods#

#currency : String #

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

View source

#currency=(currency : String) #

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

View source

#description : String #

Product description, 1-255 characters

View source

#description=(description : String) #

Product description, 1-255 characters

View source

#is_flexible=(is_flexible : Bool?) #

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

View source

#is_flexible? : Bool? #

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

View source

#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

View 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

View source

#need_email=(need_email : Bool?) #

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

View source

#need_email? : Bool? #

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

View source

#need_name=(need_name : Bool?) #

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

View source

#need_name? : Bool? #

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

View source

#need_phone_number=(need_phone_number : Bool?) #

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

View source

#need_phone_number? : Bool? #

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

View source

#need_shipping_address=(need_shipping_address : Bool?) #

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

View source

#need_shipping_address? : Bool? #

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

View source

#payload : String #

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

View source

#payload=(payload : String) #

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

View source

#photo_height : Int32 | Int64 | Nil #

Optional. Photo height

View source

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

Optional. Photo height

View source

#photo_size : Int32 | Int64 | Nil #

Optional. Photo size in bytes

View source

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

Optional. Photo size in bytes

View source

#photo_url : String? #

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

View source

#photo_url=(photo_url : String?) #

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

View source

#photo_width : Int32 | Int64 | Nil #

Optional. Photo width

View source

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

Optional. Photo width

View source

#prices : Array(Tourmaline::LabeledPrice) #

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

View 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.)

View source

#provider_data : String? #

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.

View source

#provider_data=(provider_data : String?) #

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.

View source

#provider_token : String #

Payment provider token, obtained via @BotFather

View source

#provider_token=(provider_token : String) #

Payment provider token, obtained via @BotFather

View source

#send_email_to_provider=(send_email_to_provider : Bool?) #

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

View source

#send_email_to_provider? : Bool? #

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

View source

#send_phone_number_to_provider=(send_phone_number_to_provider : Bool?) #

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

View source

#send_phone_number_to_provider? : Bool? #

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

View source

#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.

View 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.

View source

#title : String #

Product name, 1-32 characters

View source

#title=(title : String) #

Product name, 1-32 characters

View source