luarmor 0.4.0

A simple API wrapper for luarmor.net
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

use api_builder::{Endpoint, api_endpoint};
use serde::Deserialize;
use time::OffsetDateTime;
use typed_builder::TypedBuilder;

/// You can fetch the stats of your API key.
///
/// This includes
/// - usage details
/// - remaining obfuscations
/// - max obfuscations
/// - max users
/// - execution amounts
/// - monthly executions
/// - graph values
/// - etc..
///
/// ⚠️ Authenticated ⚠️
///
/// View full response at [ApiKeyStatsResponse].
///
/// [Reference](https://docs.luarmor.net/#getting-api-key-stats)
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, TypedBuilder)]
#[builder(field_defaults(setter(into)))]
pub struct ApiKeyStats<'a> {
    pub api_key: &'a str,

    /// If `true`, it will return the info about user limits. (e.g. how many users there are, # of banned, # of whitelisted)
    #[builder(default = false)]
    pub no_users: bool,
}
#[api_endpoint(method = GET, path = format!("/v3/keys/{}/stats?noUsers={}", self.api_key, self.no_users))]
impl Endpoint for ApiKeyStats<'_> {}

#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, Deserialize)]
pub struct ExecutionData {
    pub frequency: u32,
    pub executions: Vec<u32>,
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, Deserialize)]
pub struct ScriptDefaultStats {
    pub scripts: u8,
    pub users: u32,
    pub obfuscations: u32,
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize)]
pub struct ScriptStats {
    pub obfuscations: u32,
    pub scripts: u8,
    pub users: u32,
    pub attacks_blocked: u32,
    pub default: ScriptDefaultStats,
    #[serde(with = "time::serde::timestamp")]
    pub reset_at: OffsetDateTime,
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize)]
pub struct ScriptStatsNoUsers {
    pub obfuscations: u32,
    pub scripts: u8,
    pub attacks_blocked: u32,
    pub default: ScriptDefaultStats,
    #[serde(with = "time::serde::timestamp")]
    pub reset_at: OffsetDateTime,
}

/// [Reference](https://docs.luarmor.net/#tab-id-200-ok)
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize)]
pub struct ApiKeyStatsResponse {
    pub execution_data: ExecutionData,
    pub stats: ScriptStats,
}

/// [Reference](https://docs.luarmor.net/#tab-id-200-ok)
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize)]
pub struct ApiKeyStatsNoUsersResponse {
    pub execution_data: ExecutionData,
    pub stats: ScriptStatsNoUsers,
}