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

use serde::{Deserialize, Serialize};
use strum_macros::{Display, EnumString};

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

pub const URL: &str = "https://badges.roblox.com/v1";

#[derive(Copy, Clone, Debug, PartialEq, Eq, Display, EnumString)]
pub enum BadgeSortBy {
    Rank,
    DateCreated,
}

// TODO: use CreatorType instead
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq, Display, EnumString)]
pub enum BadgeCreatorType {
    User,
    Group,
}

#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq, Display, EnumString)]
pub enum BadgeAwarderType {
    Place,
}

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct BadgeStatistics {
    #[serde(rename = "pastDayAwardedCount")]
    pub awarded_today: u32,
    #[serde(rename = "awardedCount")]
    pub awarded_total: u32,
    pub win_rate_percentage: f32,
}

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

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

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct BadgeUniverse {
    pub id: u64,
    pub name: String,
    pub root_place_id: u64,
}

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

    pub display_name: String,
    pub display_description: String,

    pub enabled: bool,

    pub created: DateTime,
    pub updated: DateTime,

    pub icon_image_id: u64,
    pub display_icon_image_id: u64,

    pub statistics: BadgeStatistics,

    pub creator: Option<BadgeCreator>,
    pub awarder: Option<BadgeAwarder>,
    #[serde(rename = "awardingUniverse")]
    pub universe: Option<BadgeUniverse>,
}

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

endpoint! {
    information(id: u64) -> Badge {
        GET "{URL}/badges/{id}";
    }

    universe_badges(id: u64, sort_by: Option<BadgeSortBy>, paging: Paging<'_>) -> BadgesResponse {
        GET "{URL}/universes/{id}/badges";
        paging_query { paging, limit = 10 }
        prelude {
            let sort_by_lower = sort_by.as_ref().map(|s| s.to_string().to_lowercase());
        }
        query {
            "sortBy" => sort_by_lower.as_deref().unwrap_or(""),
        }
    }

    user_badges(id: u64, paging: Paging<'_>) -> BadgesResponse {
        GET "{URL}/users/{id}/badges";
        paging_query { paging, limit = 10 }
    }

    remove(id: u64, user_id: u64) -> () {
        DELETE "{URL}/user/{user_id}/badges/{id}";
    }

    authenticated_remove(id: u64) -> () {
        DELETE "{URL}/user/badges/{id}";
    }
}