|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * This file is part of the TelegramBot package. |
| 5 | + * |
| 6 | + * (c) Avtandil Kikabidze aka LONGMAN <[email protected]> |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespace Longman\TelegramBot\Entities\InputMessageContent; |
| 13 | + |
| 14 | +use Longman\TelegramBot\Entities\InlineQuery\InlineEntity; |
| 15 | + |
| 16 | +/** |
| 17 | + * Class InputTextMessageContent |
| 18 | + * |
| 19 | + * @link https://core.telegram.org/bots/api#inputinvoicemessagecontent |
| 20 | + * |
| 21 | + * @method string getTitle() Product name, 1-32 characters |
| 22 | + * @method string getDescription() Product description, 1-255 characters |
| 23 | + * @method string getPayload() Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
| 24 | + * @method string getProviderToken() Payment provider token, obtained via Botfather |
| 25 | + * @method string getCurrency() Three-letter ISO 4217 currency code, see more on currencies |
| 26 | + * @method LabeledPrice[] getPrices() Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| 27 | + * @method int getMaxTipAmount() 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 |
| 28 | + * @method int[] getSuggestedTipAmounts() 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. |
| 29 | + * @method string getProviderData() 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. |
| 30 | + * @method string getPhotoUrl() Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. |
| 31 | + * @method int getPhotoSize() Optional. Photo size |
| 32 | + * @method int getPhotoWidth() Optional. Photo width |
| 33 | + * @method int getPhotoHeight() Optional. Photo height |
| 34 | + * @method bool getNeedName() Optional. Pass True, if you require the user's full name to complete the order |
| 35 | + * @method bool getNeedPhoneNumber() Optional. Pass True, if you require the user's phone number to complete the order |
| 36 | + * @method bool getNeedEmail() Optional. Pass True, if you require the user's email address to complete the order |
| 37 | + * @method bool getNeedShippingAddress() Optional. Pass True, if you require the user's shipping address to complete the order |
| 38 | + * @method bool getSendPhoneNumberToProvider() Optional. Pass True, if user's phone number should be sent to provider |
| 39 | + * @method bool getSendEmailToProvider() Optional. Pass True, if user's email address should be sent to provider |
| 40 | + * @method bool getIsFlexible() Optional. Pass True, if the final price depends on the shipping method |
| 41 | + * |
| 42 | + * @method $this setTitle(string $title) Product name, 1-32 characters |
| 43 | + * @method $this setDescription(string $description) Product description, 1-255 characters |
| 44 | + * @method $this setPayload(string $payload) Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
| 45 | + * @method $this setProviderToken(string $provider_token) Payment provider token, obtained via Botfather |
| 46 | + * @method $this setCurrency(string $currency) Three-letter ISO 4217 currency code, see more on currencies |
| 47 | + * @method $this setPrices(LabeledPrice[] $prices) Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| 48 | + * @method $this setMaxTipAmount(int $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 |
| 49 | + * @method $this setSuggestedTipAmounts(int[] $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. |
| 50 | + * @method $this setProviderData(string $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. |
| 51 | + * @method $this setPhotoUrl(string $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. People like it better when they see what they are paying for. |
| 52 | + * @method $this setPhotoSize(int $photo_size) Optional. Photo size |
| 53 | + * @method $this setPhotoWidth(int $photo_width) Optional. Photo width |
| 54 | + * @method $this setPhotoHeight(int $photo_height) Optional. Photo height |
| 55 | + * @method $this setNeedName(bool $need_name) Optional. Pass True, if you require the user's full name to complete the order |
| 56 | + * @method $this setNeedPhoneNumber(bool $need_phone_number) Optional. Pass True, if you require the user's phone number to complete the order |
| 57 | + * @method $this setNeedEmail(bool $need_email) Optional. Pass True, if you require the user's email address to complete the order |
| 58 | + * @method $this setNeedShippingAddress(bool $need_shipping_address) Optional. Pass True, if you require the user's shipping address to complete the order |
| 59 | + * @method $this setSendPhoneNumberToProvider(bool $send_phone_number_to_provider) Optional. Pass True, if user's phone number should be sent to provider |
| 60 | + * @method $this setSendEmailToProvider(bool $send_email_to_provider) Optional. Pass True, if user's email address should be sent to provider |
| 61 | + * @method $this setIsFlexible(bool $is_flexible) Optional. Pass True, if the final price depends on the shipping method |
| 62 | + */ |
| 63 | +class InputInvoiceMessageContent extends InlineEntity implements InputMessageContent |
| 64 | +{ |
| 65 | + |
| 66 | +} |
0 commit comments