roblox-api 0.1.8

Roblox web api bindings
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

use serde::{Deserialize, Serialize};

use crate::{AssetTypeId, DateTime, Paging, endpoint};

pub const URL: &str = "https://games.roblox.com/v2";

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct UniverseMedia {
    pub asset_type: AssetTypeId,
    pub asset_type_id: u8,

    pub approved: bool,
    pub alt_text: Option<String>,

    pub image_id: Option<u64>,

    pub video_id: Option<String>,
    pub video_hash: Option<String>,
    pub video_title: Option<String>,
}

// TODO: use CreatorType instead
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct GameCreator {
    pub id: u64,
    #[serde(rename = "type")]
    pub kind: String,
    pub name: Option<String>,
}

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct GameRootPlace {
    pub id: u64,
    #[serde(rename = "type")]
    pub kind: String,
}

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct Game {
    pub id: u64,
    pub name: String,
    pub description: Option<String>,

    pub creator: GameCreator,
    pub root_place: GameRootPlace,

    pub created: DateTime,
    pub updated: DateTime,

    pub price: Option<u64>,
    pub place_visits: u64,
}

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct GamesResponse {
    #[serde(rename = "data")]
    pub games: Vec<Game>,
    #[serde(rename = "nextPageCursor")]
    pub next_cursor: Option<String>,
    #[serde(rename = "previousPageCursor")]
    pub previous_cursor: Option<String>,
}

endpoint! {
    universe_media(id: u64, all_experiences: bool) -> Vec<UniverseMedia> {
        GET "{URL}/games/{id}/media";
        types {
            Response {
                media("data"): Vec<UniverseMedia>,
            }
        }
        prelude {
            let all_experiences = all_experiences.to_string();
        }
        query {
            "fetchAllExperienceRelatedMedia" => &all_experiences,
        }
        map |r: Response| r.media
    }

    /// Apparently this API only works on owned groups, use v2 instead
    /// Set `access_filter` to 1, if you want a valid response
    group_games(id: u64, access_filter: u8, paging: Paging<'_>) -> GamesResponse {
        GET "{URL}/groups/{id}/games";
        paging_query { paging, limit = 10 }
        prelude {
            let access_filter = access_filter.to_string();
        }
        query {
            "accessFilter" => &access_filter,
        }
    }

    /// Set `access_filter` to 1, if you want a valid response
    group_games_v2(id: u64, access_filter: u8, paging: Paging<'_>) -> GamesResponse {
        GET "{URL}/groups/{id}/gamesV2";
        paging_query { paging, limit = 10 }
        prelude {
            let access_filter = access_filter.to_string();
        }
        query {
            "accessFilter" => &access_filter,
        }
    }

    /// Set `access_filter` to 2, if you want a valid response
    user_games(id: u64, access_filter: u8, paging: Paging<'_>) -> GamesResponse {
        GET "{URL}/users/{id}/games";
        paging_query { paging, limit = 10 }
        prelude {
            let access_filter = access_filter.to_string();
        }
        query {
            "accessFilter" => &access_filter,
        }
    }

    /// Set `access_filter` to 2, if you want a valid response
    user_favorited_games(id: u64, access_filter: u8, paging: Paging<'_>) -> GamesResponse {
        GET "{URL}/users/{id}/favorite/games";
        paging_query { paging, limit = 10 }
        prelude {
            let access_filter = access_filter.to_string();
        }
        query {
            "accessFilter" => &access_filter,
        }
    }
}