ronami_core/payloads/get_user_gifts.rs
1//! Generated by `codegen_payloads`, do not edit by hand.
2
3use serde::Serialize;
4
5use crate::types::{OwnedGifts, UserId};
6
7impl_payload! {
8 /// Returns the gifts owned and hosted by a user. Returns [`OwnedGifts`] on success.
9 ///
10 /// [`OwnedGifts`]: crate::types::OwnedGifts
11 #[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize)]
12 pub GetUserGifts (GetUserGiftsSetters) => OwnedGifts {
13 required {
14 /// Unique identifier of the user
15 pub user_id: UserId,
16 }
17 optional {
18 /// Pass _true_ to exclude gifts that can be purchased an unlimited number of times
19 pub exclude_unlimited: bool,
20 /// Pass _true_ to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
21 pub exclude_limited_upgradable: bool,
22 /// Pass _true_ to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
23 pub exclude_limited_non_upgradable: bool,
24 /// Pass _true_ to exclude gifts that were assigned from the TON blockchain
25 pub exclude_from_blockchain: bool,
26 /// Pass _true_ to exclude unique gifts
27 pub exclude_unique: bool,
28 /// Pass _true_ to sort results by gift price instead of send date
29 pub sort_by_price: bool,
30 /// Offset of the first entry to return as received from the previous request
31 pub offset: String [into],
32 /// The maximum number of gifts to be returned; 1-100. Defaults to 100
33 pub limit: u8,
34 }
35 }
36}