tele 0.1.19

Ergonomic Telegram Bot API SDK for Rust, built on reqx
Documentation
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
use serde::{Deserialize, Serialize};

use crate::Error;
use crate::types::common::ChatId;
use crate::types::telegram::{ReplyMarkup, ReplyParameters};

fn ensure_non_empty(method: &str, field: &str, value: &str) -> Result<(), Error> {
    if value.trim().is_empty() {
        return Err(Error::InvalidRequest {
            reason: format!("{method} requires non-empty `{field}`"),
        });
    }

    Ok(())
}

fn validate_currency(method: &str, currency: &str) -> Result<(), Error> {
    ensure_non_empty(method, "currency", currency)?;

    let is_valid = currency.len() == 3 && currency.bytes().all(|byte| byte.is_ascii_uppercase());
    if !is_valid {
        return Err(Error::InvalidRequest {
            reason: format!("{method} requires a 3-letter uppercase `currency` code"),
        });
    }

    Ok(())
}

fn validate_prices(method: &str, prices: &[LabeledPrice]) -> Result<(), Error> {
    if prices.is_empty() {
        return Err(Error::InvalidRequest {
            reason: format!("{method} requires at least one price item"),
        });
    }

    for (index, price) in prices.iter().enumerate() {
        if price.label.trim().is_empty() {
            return Err(Error::InvalidRequest {
                reason: format!("{method} price at index {index} requires non-empty `label`"),
            });
        }
    }

    Ok(())
}

fn validate_tip_configuration(
    method: &str,
    max_tip_amount: Option<i64>,
    suggested_tip_amounts: Option<&[i64]>,
) -> Result<(), Error> {
    if let Some(max_tip_amount) = max_tip_amount
        && max_tip_amount <= 0
    {
        return Err(Error::InvalidRequest {
            reason: format!("{method} requires `max_tip_amount` to be greater than zero"),
        });
    }

    let Some(suggested_tip_amounts) = suggested_tip_amounts else {
        return Ok(());
    };

    if suggested_tip_amounts.is_empty() {
        return Err(Error::InvalidRequest {
            reason: format!("{method} requires non-empty `suggested_tip_amounts` when provided"),
        });
    }

    if suggested_tip_amounts.len() > 4 {
        return Err(Error::InvalidRequest {
            reason: format!("{method} supports at most 4 `suggested_tip_amounts` entries"),
        });
    }

    let Some(max_tip_amount) = max_tip_amount else {
        return Err(Error::InvalidRequest {
            reason: format!(
                "{method} requires `max_tip_amount` when using `suggested_tip_amounts`"
            ),
        });
    };

    let mut previous = 0_i64;
    for amount in suggested_tip_amounts {
        if *amount <= 0 {
            return Err(Error::InvalidRequest {
                reason: format!("{method} requires positive values in `suggested_tip_amounts`"),
            });
        }
        if *amount > max_tip_amount {
            return Err(Error::InvalidRequest {
                reason: format!(
                    "{method} requires each `suggested_tip_amounts` value to be <= `max_tip_amount`"
                ),
            });
        }
        if *amount <= previous {
            return Err(Error::InvalidRequest {
                reason: format!(
                    "{method} requires strictly increasing values in `suggested_tip_amounts`"
                ),
            });
        }
        previous = *amount;
    }

    Ok(())
}

/// Telegram invoice price item.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct LabeledPrice {
    pub label: String,
    pub amount: i64,
}

impl LabeledPrice {
    pub fn new(label: impl Into<String>, amount: i64) -> Self {
        Self {
            label: label.into(),
            amount,
        }
    }
}

/// Telegram shipping option.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ShippingOption {
    pub id: String,
    pub title: String,
    pub prices: Vec<LabeledPrice>,
}

impl ShippingOption {
    pub fn new(id: impl Into<String>, title: impl Into<String>, prices: Vec<LabeledPrice>) -> Self {
        Self {
            id: id.into(),
            title: title.into(),
            prices,
        }
    }
}

/// `sendInvoice` request.
#[derive(Clone, Debug, Serialize)]
pub struct SendInvoiceRequest {
    pub chat_id: ChatId,
    pub title: String,
    pub description: String,
    pub payload: String,
    pub currency: String,
    pub prices: Vec<LabeledPrice>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub business_connection_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message_thread_id: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub direct_messages_topic_id: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider_token: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_tip_amount: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub suggested_tip_amounts: Option<Vec<i64>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub start_parameter: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider_data: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_url: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_size: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_width: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_height: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_name: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_phone_number: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_email: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_shipping_address: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub send_phone_number_to_provider: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub send_email_to_provider: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub is_flexible: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub disable_notification: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub protect_content: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub allow_paid_broadcast: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message_effect_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reply_parameters: Option<ReplyParameters>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reply_markup: Option<ReplyMarkup>,
}

impl SendInvoiceRequest {
    pub fn new(
        chat_id: impl Into<ChatId>,
        title: impl Into<String>,
        description: impl Into<String>,
        payload: impl Into<String>,
        currency: impl Into<String>,
        prices: Vec<LabeledPrice>,
    ) -> Result<Self, Error> {
        let title = title.into();
        let description = description.into();
        let payload = payload.into();
        let currency = currency.into();

        ensure_non_empty("sendInvoice", "title", &title)?;
        ensure_non_empty("sendInvoice", "description", &description)?;
        ensure_non_empty("sendInvoice", "payload", &payload)?;
        validate_currency("sendInvoice", &currency)?;
        validate_prices("sendInvoice", &prices)?;

        let request = Self {
            chat_id: chat_id.into(),
            title,
            description,
            payload,
            currency,
            prices,
            business_connection_id: None,
            message_thread_id: None,
            direct_messages_topic_id: None,
            provider_token: None,
            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,
            allow_paid_broadcast: None,
            message_effect_id: None,
            reply_parameters: None,
            reply_markup: None,
        };
        request.validate()?;
        Ok(request)
    }

    pub fn validate(&self) -> Result<(), Error> {
        ensure_non_empty("sendInvoice", "title", &self.title)?;
        ensure_non_empty("sendInvoice", "description", &self.description)?;
        ensure_non_empty("sendInvoice", "payload", &self.payload)?;
        validate_currency("sendInvoice", &self.currency)?;
        validate_prices("sendInvoice", &self.prices)?;
        validate_tip_configuration(
            "sendInvoice",
            self.max_tip_amount,
            self.suggested_tip_amounts.as_deref(),
        )?;
        Ok(())
    }

    pub fn reply_parameters(mut self, reply_parameters: ReplyParameters) -> Self {
        self.reply_parameters = Some(reply_parameters);
        self
    }

    pub fn reply_markup(mut self, reply_markup: impl Into<ReplyMarkup>) -> Self {
        self.reply_markup = Some(reply_markup.into());
        self
    }
}

/// `createInvoiceLink` request.
#[derive(Clone, Debug, Serialize)]
pub struct CreateInvoiceLinkRequest {
    pub title: String,
    pub description: String,
    pub payload: String,
    pub currency: String,
    pub prices: Vec<LabeledPrice>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub business_connection_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subscription_period: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider_token: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_tip_amount: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub suggested_tip_amounts: Option<Vec<i64>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider_data: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_url: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_size: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_width: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub photo_height: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_name: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_phone_number: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_email: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub need_shipping_address: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub send_phone_number_to_provider: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub send_email_to_provider: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub is_flexible: Option<bool>,
}

impl CreateInvoiceLinkRequest {
    pub fn new(
        title: impl Into<String>,
        description: impl Into<String>,
        payload: impl Into<String>,
        currency: impl Into<String>,
        prices: Vec<LabeledPrice>,
    ) -> Result<Self, Error> {
        let title = title.into();
        let description = description.into();
        let payload = payload.into();
        let currency = currency.into();

        ensure_non_empty("createInvoiceLink", "title", &title)?;
        ensure_non_empty("createInvoiceLink", "description", &description)?;
        ensure_non_empty("createInvoiceLink", "payload", &payload)?;
        validate_currency("createInvoiceLink", &currency)?;
        validate_prices("createInvoiceLink", &prices)?;

        let request = Self {
            title,
            description,
            payload,
            currency,
            prices,
            business_connection_id: None,
            subscription_period: None,
            provider_token: None,
            max_tip_amount: None,
            suggested_tip_amounts: 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,
        };
        request.validate()?;
        Ok(request)
    }

    pub fn validate(&self) -> Result<(), Error> {
        ensure_non_empty("createInvoiceLink", "title", &self.title)?;
        ensure_non_empty("createInvoiceLink", "description", &self.description)?;
        ensure_non_empty("createInvoiceLink", "payload", &self.payload)?;
        validate_currency("createInvoiceLink", &self.currency)?;
        validate_prices("createInvoiceLink", &self.prices)?;
        validate_tip_configuration(
            "createInvoiceLink",
            self.max_tip_amount,
            self.suggested_tip_amounts.as_deref(),
        )?;
        Ok(())
    }
}

/// `answerShippingQuery` request.
#[derive(Clone, Debug, Serialize)]
pub struct AnswerShippingQueryRequest {
    pub shipping_query_id: String,
    pub ok: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub shipping_options: Option<Vec<ShippingOption>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error_message: Option<String>,
}

impl AnswerShippingQueryRequest {
    pub fn new(shipping_query_id: impl Into<String>, ok: bool) -> Self {
        Self {
            shipping_query_id: shipping_query_id.into(),
            ok,
            shipping_options: None,
            error_message: None,
        }
    }

    pub fn validate(&self) -> Result<(), Error> {
        if self.ok {
            return Ok(());
        }

        if self
            .error_message
            .as_deref()
            .is_none_or(|value| value.trim().is_empty())
        {
            return Err(Error::InvalidRequest {
                reason: "answerShippingQuery requires non-empty error_message when ok=false"
                    .to_owned(),
            });
        }

        Ok(())
    }
}

/// `answerPreCheckoutQuery` request.
#[derive(Clone, Debug, Serialize)]
pub struct AnswerPreCheckoutQueryRequest {
    pub pre_checkout_query_id: String,
    pub ok: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error_message: Option<String>,
}

impl AnswerPreCheckoutQueryRequest {
    pub fn new(pre_checkout_query_id: impl Into<String>, ok: bool) -> Self {
        Self {
            pre_checkout_query_id: pre_checkout_query_id.into(),
            ok,
            error_message: None,
        }
    }

    pub fn validate(&self) -> Result<(), Error> {
        if self.ok {
            return Ok(());
        }

        if self
            .error_message
            .as_deref()
            .is_none_or(|value| value.trim().is_empty())
        {
            return Err(Error::InvalidRequest {
                reason: "answerPreCheckoutQuery requires non-empty error_message when ok=false"
                    .to_owned(),
            });
        }

        Ok(())
    }
}