class Tourmaline::InputInvoiceMessageContent
- Tourmaline::InputInvoiceMessageContent
- Reference
- Object
Overview
Represents the content of an invoice message to be sent as the result of an inline query.
Included Modules
- JSON::Serializable
Defined in:
tourmaline/types/api.crConstructors
- .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)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#currency : String
Three-letter ISO 4217 currency code, see more on currencies
-
#currency=(currency : String)
Three-letter ISO 4217 currency code, see more on currencies
-
#description : String
Product description, 1-255 characters
-
#description=(description : String)
Product description, 1-255 characters
-
#is_flexible=(is_flexible : Bool | Nil)
Optional.
-
#is_flexible? : Bool | Nil
Optional.
-
#max_tip_amount : Int32 | Int64 | Nil
Optional.
-
#max_tip_amount=(max_tip_amount : Int32 | Int64 | Nil)
Optional.
-
#need_email=(need_email : Bool | Nil)
Optional.
-
#need_email? : Bool | Nil
Optional.
-
#need_name=(need_name : Bool | Nil)
Optional.
-
#need_name? : Bool | Nil
Optional.
-
#need_phone_number=(need_phone_number : Bool | Nil)
Optional.
-
#need_phone_number? : Bool | Nil
Optional.
-
#need_shipping_address=(need_shipping_address : Bool | Nil)
Optional.
-
#need_shipping_address? : Bool | Nil
Optional.
-
#payload : String
Bot-defined invoice payload, 1-128 bytes.
-
#payload=(payload : String)
Bot-defined invoice payload, 1-128 bytes.
-
#photo_height : Int32 | Int64 | Nil
Optional.
-
#photo_height=(photo_height : Int32 | Int64 | Nil)
Optional.
-
#photo_size : Int32 | Int64 | Nil
Optional.
-
#photo_size=(photo_size : Int32 | Int64 | Nil)
Optional.
-
#photo_url : String | Nil
Optional.
-
#photo_url=(photo_url : String | Nil)
Optional.
-
#photo_width : Int32 | Int64 | Nil
Optional.
-
#photo_width=(photo_width : Int32 | Int64 | Nil)
Optional.
-
#prices : Array(Tourmaline::LabeledPrice)
Price breakdown, a JSON-serialized list of components (e.g.
-
#prices=(prices : Array(Tourmaline::LabeledPrice))
Price breakdown, a JSON-serialized list of components (e.g.
-
#provider_data : String | Nil
Optional.
-
#provider_data=(provider_data : String | Nil)
Optional.
-
#provider_token : String
Payment provider token, obtained via @BotFather
-
#provider_token=(provider_token : String)
Payment provider token, obtained via @BotFather
-
#send_email_to_provider=(send_email_to_provider : Bool | Nil)
Optional.
-
#send_email_to_provider? : Bool | Nil
Optional.
-
#send_phone_number_to_provider=(send_phone_number_to_provider : Bool | Nil)
Optional.
-
#send_phone_number_to_provider? : Bool | Nil
Optional.
-
#suggested_tip_amounts : Array(Int32 | Int64)
Optional.
-
#suggested_tip_amounts=(suggested_tip_amounts : Array(Int32 | Int64))
Optional.
-
#title : String
Product name, 1-32 characters
-
#title=(title : String)
Product name, 1-32 characters
Constructor Detail
Instance Method Detail
Optional. Pass True if the final price depends on the shipping method
Optional. Pass True if the final price depends on the shipping method
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
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
Optional. Pass True if you require the user's email address to complete the order
Optional. Pass True if you require the user's email address to complete the order
Optional. Pass True if you require the user's full name to complete the order
Optional. Pass True if you require the user's full name to complete the order
Optional. Pass True if you require the user's phone number to complete the order
Optional. Pass True if you require the user's phone number to complete the order
Optional. Pass True if you require the user's shipping address to complete the order
Optional. Pass True if you require the user's shipping address to complete the order
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
Price breakdown, a JSON-serialized 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.)
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.
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.
Optional. Pass True if the user's email address should be sent to provider
Optional. Pass True if the user's email address should be sent to provider
Optional. Pass True if the user's phone number should be sent to provider
Optional. Pass True if the user's phone number should be sent to provider
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.
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.