marzban_api 0.2.12

A simple async client which abstracts/simplifies the interactions with the Marzban panel API (https://github.com/Gozargah/Marzban).
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use validator::Validate;

use crate::models::base::{
    default_data_limit_reset_strategy, default_empty_string, parse_datetime, parse_some_datetime,
};

use super::admin::Admin;

#[derive(Serialize, Deserialize, Validate, Debug)]
pub struct UserCreate {
    pub proxies: Proxies,
    pub expire: Option<u64>,
    #[validate(range(min = 0))]
    pub data_limit: u64, // min: 0, can be 0 or greater
    #[serde(default = "default_data_limit_reset_strategy")]
    pub data_limit_reset_strategy: UserDataLimitResetStrategy, // default: no_reset
    pub inbounds: Inbounds,
    pub note: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_updated_at: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_last_user_agent: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub online_at: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_hold_expire_duration: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_hold_timeout: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auto_delete_in_days: Option<u64>,
    pub username: String,
    pub status: UserStatusCreate,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum UserDataLimitResetStrategy {
    #[serde(rename = "no_reset")]
    NoReset,
    #[serde(rename = "day")]
    Day,
    #[serde(rename = "week")]
    Week,
    #[serde(rename = "month")]
    Month,
    #[serde(rename = "year")]
    Year,
}

#[derive(Serialize, Deserialize, Validate, Debug)]
pub struct UserModify {
    pub proxies: Proxies,
    pub expire: Option<u64>,
    #[validate(range(min = 0))]
    pub data_limit: u64, // min: 0, can be 0 or greater
    pub data_limit_reset_strategy: UserDataLimitResetStrategy,
    pub inbounds: Inbounds,
    pub note: Option<String>,
    #[serde(deserialize_with = "parse_some_datetime")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_updated_at: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_last_user_agent: Option<String>,
    #[serde(deserialize_with = "parse_some_datetime")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub online_at: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_hold_expire_duration: Option<u64>,
    #[serde(deserialize_with = "parse_some_datetime")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_hold_timeout: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auto_delete_in_days: Option<u64>,
    pub status: UserStatusModify,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Proxies {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trojan: Option<Trojan>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vless: Option<Vless>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vmess: Option<Vmess>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shadowsocks: Option<Shadowsocks>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Trojan {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub password: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flow: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Vless {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flow: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Vmess {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub security: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Shadowsocks {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub password: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub method: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Inbounds {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trojan: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vless: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vmess: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shadowsocks: Option<Vec<String>>,
}

#[derive(Serialize, Deserialize, Validate, Debug)]
pub struct UserResponse {
    pub proxies: Proxies,
    pub expire: Option<u64>,
    #[validate(range(min = 0))]
    pub data_limit: Option<u64>, // min: 0, can be 0 or greater
    pub data_limit_reset_strategy: UserDataLimitResetStrategy, // default: no_reset
    pub inbounds: Inbounds,
    pub note: Option<String>,
    #[serde(deserialize_with = "parse_some_datetime")]
    pub sub_updated_at: Option<DateTime<Utc>>,
    pub sub_last_user_agent: Option<String>,
    #[serde(deserialize_with = "parse_some_datetime")]
    pub online_at: Option<DateTime<Utc>>,
    pub on_hold_expire_duration: Option<u64>,
    #[serde(deserialize_with = "parse_some_datetime")]
    pub on_hold_timeout: Option<DateTime<Utc>>,
    pub auto_delete_in_days: Option<u64>,
    pub username: String,
    pub status: UserStatus,
    pub used_traffic: u64,
    pub lifetime_used_traffic: u64, // default: 0
    #[serde(deserialize_with = "parse_datetime")]
    pub created_at: DateTime<Utc>,
    pub links: Vec<String>,
    #[serde(default = "default_empty_string")]
    pub subscription_url: String,
    pub excluded_inbounds: Inbounds,
    pub admin: Admin,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum UserStatus {
    #[serde(rename = "active")]
    Active,
    #[serde(rename = "disabled")]
    Disabled,
    #[serde(rename = "limited")]
    Limited,
    #[serde(rename = "expired")]
    Expired,
    #[serde(rename = "on_hold")]
    OnHold,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum UserStatusCreate {
    #[serde(rename = "active")]
    Active,
    #[serde(rename = "on_hold")]
    OnHold,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum UserStatusModify {
    #[serde(rename = "active")]
    Active,
    #[serde(rename = "disabled")]
    Disabled,
    #[serde(rename = "on_hold")]
    OnHold,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UserUsageResponse {
    pub node_id: Option<u64>,
    pub node_name: String,
    pub used_traffic: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UserUsagesResponse {
    pub username: String,
    pub usages: Vec<UserUsageResponse>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UsersResponse {
    pub users: Vec<UserResponse>,
    pub total: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UsersUsagesResponse {
    pub users: Vec<UserUsagesResponse>,
}