vrchatapi 1.20.8-nightly.15

VRChat API Client for Rust
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct CurrentUser {
    #[serde(
        rename = "acceptedPrivacyVersion",
        skip_serializing_if = "Option::is_none"
    )]
    pub accepted_privacy_version: Option<i32>,
    #[serde(rename = "acceptedTOSVersion")]
    pub accepted_tos_version: i32,
    #[serde(
        rename = "accountDeletionDate",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub account_deletion_date: Option<Option<String>>,
    #[serde(
        rename = "accountDeletionLog",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub account_deletion_log: Option<Option<Vec<models::AccountDeletionLog>>>,
    #[serde(rename = "activeFriends", skip_serializing_if = "Option::is_none")]
    pub active_friends: Option<Vec<String>>,
    #[serde(rename = "ageVerificationStatus")]
    pub age_verification_status: models::AgeVerificationStatus,
    /// `true` if, user is age verified (not 18+).
    #[serde(rename = "ageVerified")]
    pub age_verified: bool,
    #[serde(rename = "allowAvatarCopying")]
    pub allow_avatar_copying: bool,
    /// The auth token for NEWLY REGISTERED ACCOUNTS ONLY (/auth/register)
    #[serde(rename = "authToken", skip_serializing_if = "Option::is_none")]
    pub auth_token: Option<String>,
    #[serde(rename = "badges", skip_serializing_if = "Option::is_none")]
    pub badges: Option<Vec<models::Badge>>,
    #[serde(rename = "bio")]
    pub bio: String,
    #[serde(rename = "bioLinks")]
    pub bio_links: Vec<String>,
    /// These tags begin with `content_` and control content gating
    #[serde(rename = "contentFilters", skip_serializing_if = "Option::is_none")]
    pub content_filters: Option<Vec<String>>,
    #[serde(rename = "currentAvatar")]
    pub current_avatar: String,
    /// When profilePicOverride is not empty, use it instead.
    #[serde(rename = "currentAvatarImageUrl")]
    pub current_avatar_image_url: String,
    #[serde(rename = "currentAvatarTags")]
    pub current_avatar_tags: Vec<String>,
    /// When profilePicOverride is not empty, use it instead.
    #[serde(rename = "currentAvatarThumbnailImageUrl")]
    pub current_avatar_thumbnail_image_url: String,
    #[serde(rename = "date_joined")]
    pub date_joined: String,
    #[serde(rename = "developerType")]
    pub developer_type: models::DeveloperType,
    #[serde(rename = "discordDetails", skip_serializing_if = "Option::is_none")]
    pub discord_details: Option<models::DiscordDetails>,
    /// https://discord.com/developers/docs/reference#snowflakes
    #[serde(rename = "discordId", skip_serializing_if = "Option::is_none")]
    pub discord_id: Option<String>,
    #[serde(rename = "displayName")]
    pub display_name: String,
    #[serde(rename = "emailVerified")]
    pub email_verified: bool,
    #[serde(rename = "fallbackAvatar", skip_serializing_if = "Option::is_none")]
    pub fallback_avatar: Option<String>,
    /// Always empty array.
    #[serde(rename = "friendGroupNames")]
    pub friend_group_names: Vec<String>,
    #[serde(rename = "friendKey")]
    pub friend_key: String,
    #[serde(rename = "friends")]
    pub friends: Vec<String>,
    #[serde(rename = "googleDetails", skip_serializing_if = "Option::is_none")]
    pub google_details: Option<serde_json::Value>,
    #[serde(rename = "googleId", skip_serializing_if = "Option::is_none")]
    pub google_id: Option<String>,
    #[serde(rename = "hasBirthday")]
    pub has_birthday: bool,
    #[serde(rename = "hasEmail")]
    pub has_email: bool,
    #[serde(rename = "hasLoggedInFromClient")]
    pub has_logged_in_from_client: bool,
    #[serde(rename = "hasPendingEmail")]
    pub has_pending_email: bool,
    #[serde(
        rename = "hideContentFilterSettings",
        skip_serializing_if = "Option::is_none"
    )]
    pub hide_content_filter_settings: Option<bool>,
    /// WorldID be \"offline\" on User profiles if you are not friends with that user.
    #[serde(rename = "homeLocation")]
    pub home_location: String,
    /// A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.
    #[serde(rename = "id")]
    pub id: String,
    #[serde(rename = "isAdult")]
    pub is_adult: bool,
    #[serde(rename = "isBoopingEnabled", skip_serializing_if = "Option::is_none")]
    pub is_booping_enabled: Option<bool>,
    #[serde(rename = "isFriend")]
    pub is_friend: bool,
    #[serde(rename = "last_activity", skip_serializing_if = "Option::is_none")]
    pub last_activity: Option<String>,
    #[serde(rename = "last_login")]
    pub last_login: String,
    #[serde(rename = "last_mobile", deserialize_with = "Option::deserialize")]
    pub last_mobile: Option<String>,
    /// This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.
    #[serde(rename = "last_platform")]
    pub last_platform: String,
    #[serde(rename = "obfuscatedEmail")]
    pub obfuscated_email: String,
    #[serde(rename = "obfuscatedPendingEmail")]
    pub obfuscated_pending_email: String,
    #[serde(rename = "oculusId")]
    pub oculus_id: String,
    #[serde(rename = "offlineFriends", skip_serializing_if = "Option::is_none")]
    pub offline_friends: Option<Vec<String>>,
    #[serde(rename = "onlineFriends", skip_serializing_if = "Option::is_none")]
    pub online_friends: Option<Vec<String>>,
    #[serde(rename = "pastDisplayNames")]
    pub past_display_names: Vec<models::PastDisplayName>,
    #[serde(rename = "picoId", skip_serializing_if = "Option::is_none")]
    pub pico_id: Option<String>,
    #[serde(rename = "platform_history", skip_serializing_if = "Option::is_none")]
    pub platform_history: Option<Vec<models::CurrentUserPlatformHistoryInner>>,
    #[serde(rename = "presence", skip_serializing_if = "Option::is_none")]
    pub presence: Option<models::CurrentUserPresence>,
    #[serde(rename = "profilePicOverride")]
    pub profile_pic_override: String,
    #[serde(rename = "profilePicOverrideThumbnail")]
    pub profile_pic_override_thumbnail: String,
    #[serde(rename = "pronouns")]
    pub pronouns: String,
    #[serde(rename = "pronounsHistory")]
    pub pronouns_history: Vec<String>,
    #[serde(
        rename = "queuedInstance",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub queued_instance: Option<Option<String>>,
    #[serde(
        rename = "receiveMobileInvitations",
        skip_serializing_if = "Option::is_none"
    )]
    pub receive_mobile_invitations: Option<bool>,
    #[serde(rename = "state")]
    pub state: models::UserState,
    #[serde(rename = "status")]
    pub status: models::UserStatus,
    #[serde(rename = "statusDescription")]
    pub status_description: String,
    #[serde(rename = "statusFirstTime")]
    pub status_first_time: bool,
    #[serde(rename = "statusHistory")]
    pub status_history: Vec<String>,
    #[serde(rename = "steamDetails")]
    pub steam_details: serde_json::Value,
    #[serde(rename = "steamId")]
    pub steam_id: String,
    #[serde(rename = "tags")]
    pub tags: Vec<String>,
    #[serde(rename = "twoFactorAuthEnabled")]
    pub two_factor_auth_enabled: bool,
    #[serde(
        rename = "twoFactorAuthEnabledDate",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub two_factor_auth_enabled_date: Option<Option<String>>,
    #[serde(rename = "unsubscribe")]
    pub unsubscribe: bool,
    #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    #[serde(rename = "userIcon")]
    pub user_icon: String,
    #[serde(
        rename = "userLanguage",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub user_language: Option<Option<String>>,
    #[serde(
        rename = "userLanguageCode",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub user_language_code: Option<Option<String>>,
    /// -| **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
    #[serde(rename = "username", skip_serializing_if = "Option::is_none")]
    pub username: Option<String>,
    #[serde(rename = "usesGeneratedPassword")]
    pub uses_generated_password: bool,
    #[serde(rename = "viveId", skip_serializing_if = "Option::is_none")]
    pub vive_id: Option<String>,
}

impl CurrentUser {
    pub fn new(
        accepted_tos_version: i32,
        age_verification_status: models::AgeVerificationStatus,
        age_verified: bool,
        allow_avatar_copying: bool,
        bio: String,
        bio_links: Vec<String>,
        current_avatar: String,
        current_avatar_image_url: String,
        current_avatar_tags: Vec<String>,
        current_avatar_thumbnail_image_url: String,
        date_joined: String,
        developer_type: models::DeveloperType,
        display_name: String,
        email_verified: bool,
        friend_group_names: Vec<String>,
        friend_key: String,
        friends: Vec<String>,
        has_birthday: bool,
        has_email: bool,
        has_logged_in_from_client: bool,
        has_pending_email: bool,
        home_location: String,
        id: String,
        is_adult: bool,
        is_friend: bool,
        last_login: String,
        last_mobile: Option<String>,
        last_platform: String,
        obfuscated_email: String,
        obfuscated_pending_email: String,
        oculus_id: String,
        past_display_names: Vec<models::PastDisplayName>,
        profile_pic_override: String,
        profile_pic_override_thumbnail: String,
        pronouns: String,
        pronouns_history: Vec<String>,
        state: models::UserState,
        status: models::UserStatus,
        status_description: String,
        status_first_time: bool,
        status_history: Vec<String>,
        steam_details: serde_json::Value,
        steam_id: String,
        tags: Vec<String>,
        two_factor_auth_enabled: bool,
        unsubscribe: bool,
        user_icon: String,
        uses_generated_password: bool,
    ) -> CurrentUser {
        CurrentUser {
            accepted_privacy_version: None,
            accepted_tos_version,
            account_deletion_date: None,
            account_deletion_log: None,
            active_friends: None,
            age_verification_status,
            age_verified,
            allow_avatar_copying,
            auth_token: None,
            badges: None,
            bio,
            bio_links,
            content_filters: None,
            current_avatar,
            current_avatar_image_url,
            current_avatar_tags,
            current_avatar_thumbnail_image_url,
            date_joined,
            developer_type,
            discord_details: None,
            discord_id: None,
            display_name,
            email_verified,
            fallback_avatar: None,
            friend_group_names,
            friend_key,
            friends,
            google_details: None,
            google_id: None,
            has_birthday,
            has_email,
            has_logged_in_from_client,
            has_pending_email,
            hide_content_filter_settings: None,
            home_location,
            id,
            is_adult,
            is_booping_enabled: None,
            is_friend,
            last_activity: None,
            last_login,
            last_mobile,
            last_platform,
            obfuscated_email,
            obfuscated_pending_email,
            oculus_id,
            offline_friends: None,
            online_friends: None,
            past_display_names,
            pico_id: None,
            platform_history: None,
            presence: None,
            profile_pic_override,
            profile_pic_override_thumbnail,
            pronouns,
            pronouns_history,
            queued_instance: None,
            receive_mobile_invitations: None,
            state,
            status,
            status_description,
            status_first_time,
            status_history,
            steam_details,
            steam_id,
            tags,
            two_factor_auth_enabled,
            two_factor_auth_enabled_date: None,
            unsubscribe,
            updated_at: None,
            user_icon,
            user_language: None,
            user_language_code: None,
            username: None,
            uses_generated_password,
            vive_id: None,
        }
    }
}