telers 1.0.0-beta.2

An asynchronous framework for Telegram Bot API written in Rust
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
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
use crate::client::Bot;
use serde::Serialize;
/// Use this method to create a link for an invoice. Returns the created invoice link as String on success.
/// # Documentation
/// <https://core.telegram.org/bots/api#createinvoicelink>
/// # Returns
/// - `Box<str>`
#[derive(Clone, Debug, Serialize)]
pub struct CreateInvoiceLink {
    /// Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub business_connection_id: Option<Box<str>>,
    /// Product name, 1-32 characters
    pub title: Box<str>,
    /// Product description, 1-255 characters
    pub description: Box<str>,
    /// Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    pub payload: Box<str>,
    /// Payment provider token, obtained via @`BotFather`. Pass an empty string for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider_token: Option<Box<str>>,
    /// Three-letter ISO 4217 currency code, see more on currencies. Pass `XTR` for payments in Telegram Stars.
    pub currency: Box<str>,
    /// 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.
    pub prices: Box<[crate::types::LabeledPrice]>,
    /// The number of seconds the subscription will be active for before the next payment. The currency must be set to `XTR` (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_period: Option<i64>,
    /// 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.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_tip_amount: Option<i64>,
    /// A JSON-serialized array of suggested amounts of tips 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`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub suggested_tip_amounts: Option<Box<[i64]>>,
    /// JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider_data: Option<Box<str>>,
    /// URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub photo_url: Option<Box<str>>,
    /// Photo size in bytes
    #[serde(skip_serializing_if = "Option::is_none")]
    pub photo_size: Option<i64>,
    /// Photo width
    #[serde(skip_serializing_if = "Option::is_none")]
    pub photo_width: Option<i64>,
    /// Photo height
    #[serde(skip_serializing_if = "Option::is_none")]
    pub photo_height: Option<i64>,
    /// Pass `true` if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub need_name: Option<bool>,
    /// Pass `true` if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub need_phone_number: Option<bool>,
    /// Pass `true` if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub need_email: Option<bool>,
    /// Pass `true` if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub need_shipping_address: Option<bool>,
    /// Pass `true` if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_phone_number_to_provider: Option<bool>,
    /// Pass `true` if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_email_to_provider: Option<bool>,
    /// Pass `true` if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_flexible: Option<bool>,
}
impl CreateInvoiceLink {
    /// Creates a new `CreateInvoiceLink`.
    ///
    /// # Arguments
    /// * `title` - Product name, 1-32 characters
    /// * `description` - Product description, 1-255 characters
    /// * `payload` - Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    /// * `currency` - Three-letter ISO 4217 currency code, see more on currencies. Pass `XTR` for payments in Telegram Stars.
    /// * `prices` - 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.
    ///
    /// # Notes
    /// Use builder methods to set optional fields.
    #[must_use]
    pub fn new<
        T0: Into<Box<str>>,
        T1: Into<Box<str>>,
        T2: Into<Box<str>>,
        T3: Into<Box<str>>,
        T4Item: Into<crate::types::LabeledPrice>,
        T4: IntoIterator<Item = T4Item>,
    >(
        title: T0,
        description: T1,
        payload: T2,
        currency: T3,
        prices: T4,
    ) -> Self {
        Self {
            business_connection_id: None,
            title: title.into(),
            description: description.into(),
            payload: payload.into(),
            provider_token: None,
            currency: currency.into(),
            prices: prices.into_iter().map(Into::into).collect(),
            subscription_period: 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,
        }
    }

    /// Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
    #[must_use]
    pub fn business_connection_id<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.business_connection_id = Some(val.into());
        this
    }

    /// Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
    #[must_use]
    pub fn business_connection_id_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.business_connection_id = val.map(Into::into);
        this
    }

    /// Product name, 1-32 characters
    #[must_use]
    pub fn title<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.title = val.into();
        this
    }

    /// Product description, 1-255 characters
    #[must_use]
    pub fn description<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.description = val.into();
        this
    }

    /// Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    #[must_use]
    pub fn payload<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.payload = val.into();
        this
    }

    /// Payment provider token, obtained via @`BotFather`. Pass an empty string for payments in Telegram Stars.
    #[must_use]
    pub fn provider_token<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.provider_token = Some(val.into());
        this
    }

    /// Payment provider token, obtained via @`BotFather`. Pass an empty string for payments in Telegram Stars.
    #[must_use]
    pub fn provider_token_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.provider_token = val.map(Into::into);
        this
    }

    /// Three-letter ISO 4217 currency code, see more on currencies. Pass `XTR` for payments in Telegram Stars.
    #[must_use]
    pub fn currency<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.currency = val.into();
        this
    }

    /// 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.
    ///
    /// # Notes
    /// Adds multiple elements.
    #[must_use]
    pub fn prices<TItem: Into<crate::types::LabeledPrice>, T: IntoIterator<Item = TItem>>(
        self,
        val: T,
    ) -> Self {
        let mut this = self;
        this.prices = this
            .prices
            .into_vec()
            .into_iter()
            .chain(val.into_iter().map(Into::into))
            .collect();
        this
    }

    /// 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.
    ///
    /// # Notes
    /// Adds a single element.
    #[must_use]
    pub fn price<T: Into<crate::types::LabeledPrice>>(self, val: T) -> Self {
        let mut this = self;
        this.prices = this
            .prices
            .into_vec()
            .into_iter()
            .chain(Some(val.into()))
            .collect();
        this
    }

    /// The number of seconds the subscription will be active for before the next payment. The currency must be set to `XTR` (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
    #[must_use]
    pub fn subscription_period<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.subscription_period = Some(val.into());
        this
    }

    /// The number of seconds the subscription will be active for before the next payment. The currency must be set to `XTR` (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
    #[must_use]
    pub fn subscription_period_option<T: Into<i64>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.subscription_period = val.map(Into::into);
        this
    }

    /// 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.
    #[must_use]
    pub fn max_tip_amount<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.max_tip_amount = Some(val.into());
        this
    }

    /// 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.
    #[must_use]
    pub fn max_tip_amount_option<T: Into<i64>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.max_tip_amount = val.map(Into::into);
        this
    }

    /// A JSON-serialized array of suggested amounts of tips 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`.
    ///
    /// # Notes
    /// Adds multiple elements.
    #[must_use]
    pub fn suggested_tip_amounts<TItem: Into<i64>, T: IntoIterator<Item = TItem>>(
        self,
        val: T,
    ) -> Self {
        let mut this = self;
        this.suggested_tip_amounts = Some(
            this.suggested_tip_amounts
                .unwrap_or_default()
                .into_vec()
                .into_iter()
                .chain(val.into_iter().map(Into::into))
                .collect(),
        );
        this
    }

    /// A JSON-serialized array of suggested amounts of tips 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`.
    ///
    /// # Notes
    /// Adds a single element.
    #[must_use]
    pub fn suggested_tip_amount<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.suggested_tip_amounts = Some(
            this.suggested_tip_amounts
                .unwrap_or_default()
                .into_vec()
                .into_iter()
                .chain(Some(val.into()))
                .collect(),
        );
        this
    }

    /// A JSON-serialized array of suggested amounts of tips 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`.
    ///
    /// # Notes
    /// Adds multiple elements.
    #[must_use]
    pub fn suggested_tip_amounts_option<TItem: Into<i64>, T: IntoIterator<Item = TItem>>(
        self,
        val: Option<T>,
    ) -> Self {
        let mut this = self;
        this.suggested_tip_amounts = val.map(|v| v.into_iter().map(Into::into).collect());
        this
    }

    /// JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
    #[must_use]
    pub fn provider_data<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.provider_data = Some(val.into());
        this
    }

    /// JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
    #[must_use]
    pub fn provider_data_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.provider_data = val.map(Into::into);
        this
    }

    /// URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
    #[must_use]
    pub fn photo_url<T: Into<Box<str>>>(self, val: T) -> Self {
        let mut this = self;
        this.photo_url = Some(val.into());
        this
    }

    /// URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
    #[must_use]
    pub fn photo_url_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.photo_url = val.map(Into::into);
        this
    }

    /// Photo size in bytes
    #[must_use]
    pub fn photo_size<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.photo_size = Some(val.into());
        this
    }

    /// Photo size in bytes
    #[must_use]
    pub fn photo_size_option<T: Into<i64>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.photo_size = val.map(Into::into);
        this
    }

    /// Photo width
    #[must_use]
    pub fn photo_width<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.photo_width = Some(val.into());
        this
    }

    /// Photo width
    #[must_use]
    pub fn photo_width_option<T: Into<i64>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.photo_width = val.map(Into::into);
        this
    }

    /// Photo height
    #[must_use]
    pub fn photo_height<T: Into<i64>>(self, val: T) -> Self {
        let mut this = self;
        this.photo_height = Some(val.into());
        this
    }

    /// Photo height
    #[must_use]
    pub fn photo_height_option<T: Into<i64>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.photo_height = val.map(Into::into);
        this
    }

    /// Pass `true` if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_name<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.need_name = Some(val.into());
        this
    }

    /// Pass `true` if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_name_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.need_name = val.map(Into::into);
        this
    }

    /// Pass `true` if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_phone_number<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.need_phone_number = Some(val.into());
        this
    }

    /// Pass `true` if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_phone_number_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.need_phone_number = val.map(Into::into);
        this
    }

    /// Pass `true` if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_email<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.need_email = Some(val.into());
        this
    }

    /// Pass `true` if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_email_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.need_email = val.map(Into::into);
        this
    }

    /// Pass `true` if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_shipping_address<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.need_shipping_address = Some(val.into());
        this
    }

    /// Pass `true` if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn need_shipping_address_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.need_shipping_address = val.map(Into::into);
        this
    }

    /// Pass `true` if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn send_phone_number_to_provider<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.send_phone_number_to_provider = Some(val.into());
        this
    }

    /// Pass `true` if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn send_phone_number_to_provider_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.send_phone_number_to_provider = val.map(Into::into);
        this
    }

    /// Pass `true` if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn send_email_to_provider<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.send_email_to_provider = Some(val.into());
        this
    }

    /// Pass `true` if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn send_email_to_provider_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.send_email_to_provider = val.map(Into::into);
        this
    }

    /// Pass `true` if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn is_flexible<T: Into<bool>>(self, val: T) -> Self {
        let mut this = self;
        this.is_flexible = Some(val.into());
        this
    }

    /// Pass `true` if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    #[must_use]
    pub fn is_flexible_option<T: Into<bool>>(self, val: Option<T>) -> Self {
        let mut this = self;
        this.is_flexible = val.map(Into::into);
        this
    }
}
impl super::TelegramMethod for CreateInvoiceLink {
    type Method = Self;
    type Return = Box<str>;

    fn build_request<Client>(self, _bot: &Bot<Client>) -> super::Request<Self::Method> {
        super::Request::new("createInvoiceLink", self, None)
    }
}