1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
use super::base::{Request, TelegramMethod};
use crate::{
client::Bot,
types::{ChatIdKind, InlineKeyboardMarkup, LabeledPrice, Message, ReplyParameters},
};
use serde::Serialize;
use serde_with::skip_serializing_none;
/// Use this method to send invoices
/// # Documentation
/// <https://core.telegram.org/bots/api#sendinvoice>
/// # Returns
/// On success, the sent [`Message`] is returned
#[skip_serializing_none]
#[derive(Debug, Clone, Hash, PartialEq, Eq, Serialize)]
pub struct SendInvoice {
/// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
pub chat_id: ChatIdKind,
/// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
pub message_thread_id: Option<i64>,
/// Product name, 1-32 characters
pub title: String,
/// Product description, 1-255 characters
pub description: String,
/// Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
pub payload: String,
/// Payments provider token, obtained via [`Botfather`](https://t.me/botfather)
pub provider_token: String,
/// Three-letter ISO 4217 currency code, see [`more on currencies`](https://core.telegram.org/bots/payments#supported-currencies)
pub currency: String,
/// Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
pub prices: Vec<LabeledPrice>,
/// 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`](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0
pub max_tip_amount: Option<i64>,
/// 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`.
pub suggested_tip_amounts: Option<Vec<i64>>,
/// Unique deep-linking parameter. If left empty, **forwarded copies** of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.
pub start_parameter: Option<String>,
/// 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.
pub provider_data: Option<String>,
/// URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
pub photo_url: Option<String>,
/// Photo size in bytes
pub photo_size: Option<i64>,
/// Photo width
pub photo_width: Option<i64>,
/// Photo height
pub photo_height: Option<i64>,
/// Pass `true` if you require the user's full name to complete the order
pub need_name: Option<bool>,
/// Pass `true` if you require the user's phone number to complete the order
pub need_phone_number: Option<bool>,
/// Pass `true` if you require the user's email address to complete the order
pub need_email: Option<bool>,
/// Pass `true` if you require the user's shipping address to complete the order
pub need_shipping_address: Option<bool>,
/// Pass `true` if the user's phone number should be sent to provider
pub send_phone_number_to_provider: Option<bool>,
/// Pass `true` if the user's email address should be sent to provider
pub send_email_to_provider: Option<bool>,
/// Pass `true` if the final price depends on the shipping method
pub is_flexible: Option<bool>,
/// Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
pub disable_notification: Option<bool>,
/// Protects the contents of the sent message from forwarding and saving
pub protect_content: Option<bool>,
/// Description of the message to reply to
pub reply_parameters: Option<ReplyParameters>,
/// A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards). If empty, one 'Pay `total price`' button will be shown. If not empty, the first button must be a Pay button.
pub reply_markup: Option<InlineKeyboardMarkup>,
}
impl SendInvoice {
#[must_use]
pub fn new(
chat_id: impl Into<ChatIdKind>,
title: impl Into<String>,
description: impl Into<String>,
payload: impl Into<String>,
provider_token: impl Into<String>,
currency: impl Into<String>,
prices: impl IntoIterator<Item = LabeledPrice>,
) -> Self {
Self {
chat_id: chat_id.into(),
message_thread_id: None,
title: title.into(),
description: description.into(),
payload: payload.into(),
provider_token: provider_token.into(),
currency: currency.into(),
prices: prices.into_iter().collect(),
max_tip_amount: None,
suggested_tip_amounts: None,
start_parameter: None,
provider_data: None,
photo_url: None,
photo_size: None,
photo_width: None,
photo_height: None,
need_name: None,
need_phone_number: None,
need_email: None,
need_shipping_address: None,
send_phone_number_to_provider: None,
send_email_to_provider: None,
is_flexible: None,
disable_notification: None,
protect_content: None,
reply_parameters: None,
reply_markup: None,
}
}
#[must_use]
pub fn chat_id(self, val: impl Into<ChatIdKind>) -> Self {
Self {
chat_id: val.into(),
..self
}
}
#[must_use]
pub fn message_thread_id(self, val: i64) -> Self {
Self {
message_thread_id: Some(val),
..self
}
}
#[must_use]
pub fn title(self, val: impl Into<String>) -> Self {
Self {
title: val.into(),
..self
}
}
#[must_use]
pub fn description(self, val: impl Into<String>) -> Self {
Self {
description: val.into(),
..self
}
}
#[must_use]
pub fn payload(self, val: impl Into<String>) -> Self {
Self {
payload: val.into(),
..self
}
}
#[must_use]
pub fn provider_token(self, val: impl Into<String>) -> Self {
Self {
provider_token: val.into(),
..self
}
}
#[must_use]
pub fn currency(self, val: impl Into<String>) -> Self {
Self {
currency: val.into(),
..self
}
}
#[must_use]
pub fn price(self, val: LabeledPrice) -> Self {
Self {
prices: self.prices.into_iter().chain(Some(val)).collect(),
..self
}
}
#[must_use]
pub fn prices(self, val: impl IntoIterator<Item = LabeledPrice>) -> Self {
Self {
prices: self.prices.into_iter().chain(val).collect(),
..self
}
}
#[must_use]
pub fn suggested_tip_amount(self, val: i64) -> Self {
Self {
suggested_tip_amounts: Some(
self.suggested_tip_amounts
.unwrap_or_default()
.into_iter()
.chain(Some(val))
.collect(),
),
..self
}
}
#[must_use]
pub fn suggested_tip_amounts(self, val: impl IntoIterator<Item = i64>) -> Self {
Self {
suggested_tip_amounts: Some(
self.suggested_tip_amounts
.unwrap_or_default()
.into_iter()
.chain(val)
.collect(),
),
..self
}
}
#[must_use]
pub fn start_parameter(self, val: impl Into<String>) -> Self {
Self {
start_parameter: Some(val.into()),
..self
}
}
#[must_use]
pub fn provider_data(self, val: impl Into<String>) -> Self {
Self {
provider_data: Some(val.into()),
..self
}
}
#[must_use]
pub fn photo_url(self, val: impl Into<String>) -> Self {
Self {
photo_url: Some(val.into()),
..self
}
}
#[must_use]
pub fn photo_size(self, val: i64) -> Self {
Self {
photo_size: Some(val),
..self
}
}
#[must_use]
pub fn photo_width(self, val: i64) -> Self {
Self {
photo_width: Some(val),
..self
}
}
#[must_use]
pub fn photo_height(self, val: i64) -> Self {
Self {
photo_height: Some(val),
..self
}
}
#[must_use]
pub fn need_name(self, val: bool) -> Self {
Self {
need_name: Some(val),
..self
}
}
#[must_use]
pub fn need_phone_number(self, val: bool) -> Self {
Self {
need_phone_number: Some(val),
..self
}
}
#[must_use]
pub fn need_email(self, val: bool) -> Self {
Self {
need_email: Some(val),
..self
}
}
#[must_use]
pub fn need_shipping_address(self, val: bool) -> Self {
Self {
need_shipping_address: Some(val),
..self
}
}
#[must_use]
pub fn send_phone_number_to_provider(self, val: bool) -> Self {
Self {
send_phone_number_to_provider: Some(val),
..self
}
}
#[must_use]
pub fn send_email_to_provider(self, val: bool) -> Self {
Self {
send_email_to_provider: Some(val),
..self
}
}
#[must_use]
pub fn is_flexible(self, val: bool) -> Self {
Self {
is_flexible: Some(val),
..self
}
}
#[must_use]
pub fn disable_notification(self, val: bool) -> Self {
Self {
disable_notification: Some(val),
..self
}
}
#[must_use]
pub fn protect_content(self, val: bool) -> Self {
Self {
protect_content: Some(val),
..self
}
}
#[must_use]
pub fn reply_parameters(self, val: ReplyParameters) -> Self {
Self {
reply_parameters: Some(val),
..self
}
}
#[must_use]
pub fn reply_markup(self, val: impl Into<InlineKeyboardMarkup>) -> Self {
Self {
reply_markup: Some(val.into()),
..self
}
}
}
impl SendInvoice {
#[must_use]
pub fn max_tip_amount_option(self, val: Option<i64>) -> Self {
Self {
max_tip_amount: val,
..self
}
}
#[must_use]
pub fn suggested_tip_amounts_option(self, val: Option<impl IntoIterator<Item = i64>>) -> Self {
Self {
suggested_tip_amounts: val.map(|val| val.into_iter().collect()),
..self
}
}
#[must_use]
pub fn start_parameter_option(self, val: Option<impl Into<String>>) -> Self {
Self {
start_parameter: val.map(Into::into),
..self
}
}
#[must_use]
pub fn provider_data_option(self, val: Option<impl Into<String>>) -> Self {
Self {
provider_data: val.map(Into::into),
..self
}
}
#[must_use]
pub fn photo_url_option(self, val: Option<impl Into<String>>) -> Self {
Self {
photo_url: val.map(Into::into),
..self
}
}
#[must_use]
pub fn photo_size_option(self, val: Option<i64>) -> Self {
Self {
photo_size: val,
..self
}
}
#[must_use]
pub fn photo_width_option(self, val: Option<i64>) -> Self {
Self {
photo_width: val,
..self
}
}
#[must_use]
pub fn photo_height_option(self, val: Option<i64>) -> Self {
Self {
photo_height: val,
..self
}
}
#[must_use]
pub fn need_name_option(self, val: Option<bool>) -> Self {
Self {
need_name: val,
..self
}
}
#[must_use]
pub fn need_phone_number_option(self, val: Option<bool>) -> Self {
Self {
need_phone_number: val,
..self
}
}
#[must_use]
pub fn need_email_option(self, val: Option<bool>) -> Self {
Self {
need_email: val,
..self
}
}
#[must_use]
pub fn need_shipping_address_option(self, val: Option<bool>) -> Self {
Self {
need_shipping_address: val,
..self
}
}
#[must_use]
pub fn send_phone_number_to_provider_option(self, val: Option<bool>) -> Self {
Self {
send_phone_number_to_provider: val,
..self
}
}
#[must_use]
pub fn send_email_to_provider_option(self, val: Option<bool>) -> Self {
Self {
send_email_to_provider: val,
..self
}
}
#[must_use]
pub fn is_flexible_option(self, val: Option<bool>) -> Self {
Self {
is_flexible: val,
..self
}
}
#[must_use]
pub fn disable_notification_option(self, val: Option<bool>) -> Self {
Self {
disable_notification: val,
..self
}
}
#[must_use]
pub fn protect_content_option(self, val: Option<bool>) -> Self {
Self {
protect_content: val,
..self
}
}
#[must_use]
pub fn reply_parameters_option(self, val: Option<ReplyParameters>) -> Self {
Self {
reply_parameters: val,
..self
}
}
#[must_use]
pub fn reply_markup_option(self, val: Option<impl Into<InlineKeyboardMarkup>>) -> Self {
Self {
reply_markup: val.map(Into::into),
..self
}
}
}
impl TelegramMethod for SendInvoice {
type Method = Self;
type Return = Message;
fn build_request<Client>(&self, _bot: &Bot<Client>) -> Request<Self::Method> {
Request::new("sendInvoice", self, None)
}
}
impl AsRef<SendInvoice> for SendInvoice {
fn as_ref(&self) -> &Self {
self
}
}