class Tourmaline::InputInvoiceMessageContent

Overview

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

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(title : String, description : String, payload : String, currency : String, prices : Array(Tourmaline::LabeledPrice) = [] of Tourmaline::LabeledPrice, provider_token : String | Nil = nil, 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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def currency : String #

Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR" for payments in Telegram Stars.


[View source]
def currency=(currency : String) #

Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR" for payments in Telegram Stars.


[View source]
def description : String #

Product description, 1-255 characters


[View source]
def description=(description : String) #

Product description, 1-255 characters


[View source]
def is_flexible=(is_flexible : Bool | Nil) #

Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.


[View source]
def is_flexible? : Bool | Nil #

Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.


[View source]
def 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. Not supported for payments in Telegram Stars.


[View source]
def 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. Not supported for payments in Telegram Stars.


[View source]
def need_email=(need_email : Bool | Nil) #

Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_email? : Bool | Nil #

Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_name=(need_name : Bool | Nil) #

Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_name? : Bool | Nil #

Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_phone_number=(need_phone_number : Bool | Nil) #

Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_phone_number? : Bool | Nil #

Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_shipping_address=(need_shipping_address : Bool | Nil) #

Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.


[View source]
def need_shipping_address? : Bool | Nil #

Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.


[View source]
def payload : String #

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


[View source]
def payload=(payload : String) #

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


[View source]
def photo_height : Int32 | Int64 | Nil #

Optional. Photo height


[View source]
def photo_height=(photo_height : Int32 | Int64 | Nil) #

Optional. Photo height


[View source]
def photo_size : Int32 | Int64 | Nil #

Optional. Photo size in bytes


[View source]
def photo_size=(photo_size : Int32 | Int64 | Nil) #

Optional. Photo size in bytes


[View source]
def 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.


[View source]
def 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.


[View source]
def photo_width : Int32 | Int64 | Nil #

Optional. Photo width


[View source]
def photo_width=(photo_width : Int32 | Int64 | Nil) #

Optional. Photo width


[View source]
def prices : Array(Tourmaline::LabeledPrice) #

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.


[View source]
def 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.). Must contain exactly one item for payments in Telegram Stars.


[View source]
def 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.


[View source]
def 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.


[View source]
def provider_token : String | Nil #

Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.


[View source]
def provider_token=(provider_token : String | Nil) #

Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.


[View source]
def send_email_to_provider=(send_email_to_provider : Bool | Nil) #

Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.


[View source]
def send_email_to_provider? : Bool | Nil #

Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.


[View source]
def 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 the provider. Ignored for payments in Telegram Stars.


[View source]
def send_phone_number_to_provider? : Bool | Nil #

Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.


[View source]
def 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]
def 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]
def title : String #

Product name, 1-32 characters


[View source]
def title=(title : String) #

Product name, 1-32 characters


[View source]