roboat 0.39.0

A high performance interface for the Roblox API.
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

use serde::{Deserialize, Serialize};

// [Friends list structs]

/// Structure that contains vector of data (FriendUserInformation) from FrindsList Response
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct FriendsListResponse {
    pub data: Vec<FriendUserInformation>,
}

/// Model, representing user information that also contains select presence information
#[allow(missing_docs)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FriendUserInformation {
    pub id: u64,
    pub name: String,
    pub display_name: String,
}

// [Pending request struct]

/// Struct to get the count of friend requests
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(super) struct PendingFriendRequestsResponse {
    pub count: u64,
}

// [Friend requests structs]

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct RequestResponseData {
    #[serde(rename = "friendRequest")]
    pub request_info: RequestInfo,
    pub mutual_friends_list: Vec<String>,
    pub id: u64,
    pub name: String,
    pub display_name: String,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct RequestInfo {
    pub sent_at: String,
    pub sender_id: u64,
    pub source_universe_id: u64,
    pub origin_source_type: OriginSource,
    // NOTE:These are always null
    // contact_name: Option<String>,
    // sender_nickname: String,
}

/// Represents the source of a friend request or friend connection
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum OriginSource {
    /// Source is unknown or not specified
    #[serde(rename = "Unknown")]
    Unknown = 0,

    /// Friend was found through player search
    #[serde(rename = "PlayerSearch")]
    PlayerSearch = 1,

    /// Friend was added via QR code
    #[serde(rename = "QrCode")]
    QrCode = 2,

    /// Friend was met in-game
    #[serde(rename = "InGame")]
    InGame = 3,

    /// Friend was found through user profile
    #[serde(rename = "UserProfile")]
    UserProfile = 4,

    /// Friend was imported from QQ contacts
    #[serde(rename = "QqContactImporter")]
    QqContactImporter = 5,

    /// Friend was imported from WeChat contacts
    #[serde(rename = "WeChatContactImporter")]
    WeChatContactImporter = 6,

    /// Friend was added through profile sharing
    #[serde(rename = "ProfileShare")]
    ProfileShare = 7,

    /// Friend was imported from phone contacts
    #[serde(rename = "PhoneContactImporter")]
    PhoneContactImporter = 8,

    /// Friend was suggested through recommendations
    #[serde(rename = "FriendRecommendations")]
    FriendRecommendations = 9,
}

impl Default for OriginSource {
    fn default() -> Self {
        OriginSource::Unknown
    }
}

// Optionally, implement From<u8> to convert from numeric values
impl From<u8> for OriginSource {
    fn from(value: u8) -> Self {
        match value {
            1 => OriginSource::PlayerSearch,
            2 => OriginSource::QrCode,
            3 => OriginSource::InGame,
            4 => OriginSource::UserProfile,
            5 => OriginSource::QqContactImporter,
            6 => OriginSource::WeChatContactImporter,
            7 => OriginSource::ProfileShare,
            8 => OriginSource::PhoneContactImporter,
            9 => OriginSource::FriendRecommendations,
            _ => OriginSource::Unknown,
        }
    }
}