vrc 0.5.0

Unofficial rust types of VRChat's API
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

use racal::Queryable;
use serde::{Deserialize, Serialize};

use super::{Authentication, Pagination};

/// Gets information about a specific group
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct Group {
	/// The ID of the group to get information about
	pub id: crate::id::Group,
}

impl Queryable<Authentication, crate::model::Group> for Group {
	fn url(&self, _: &Authentication) -> String {
		format!("{}/groups/{}", crate::API_BASE_URI, self.id.as_ref())
	}
}

/// Gets audit logs from a specific group
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct GroupAuditLogs {
	/// The ID of the group to get audit logs from
	pub id: crate::id::Group,
	/// Limits how many results are returned
	#[serde(flatten)]
	pub pagination: Pagination,
}

impl Queryable<Authentication, crate::model::GroupAuditLogs>
	for GroupAuditLogs
{
	fn url(&self, _: &Authentication) -> String {
		format!(
			"{}/groups/{}/auditLogs?{}",
			crate::API_BASE_URI,
			self.id.as_ref(),
			self.pagination.to_query_str()
		)
	}
}

/// Gets the bans from a group
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct GroupBans {
	/// The ID of the group
	pub id: crate::id::Group,
	/// Limits how many results are returned
	#[serde(flatten)]
	pub pagination: Pagination,
}

impl Queryable<Authentication, Vec<crate::model::GroupBan>> for GroupBans {
	fn url(&self, _: &Authentication) -> String {
		format!(
			"{}/groups/{}/bans?{}",
			crate::API_BASE_URI,
			self.id.as_ref(),
			self.pagination.to_query_str()
		)
	}
}

/// Bans a user from a Group.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct GroupBan {
	/// The ID of the group
	pub group_id: crate::id::Group,
	/// The ID of the user to ban
	pub user_id: crate::id::User,
}

impl Queryable<Authentication, crate::model::GroupBan> for GroupBan {
	fn url(&self, _: &Authentication) -> String {
		format!("{}/groups/{}/bans", crate::API_BASE_URI, self.group_id.as_ref(),)
	}

	fn body(
		&self, _state: &Authentication,
	) -> Option<serde_json::Result<Vec<u8>>> {
		Some(serde_json::to_vec(
			&serde_json::json!({ "userId": self.user_id.as_ref() }),
		))
	}

	fn method(&self, _state: &Authentication) -> racal::RequestMethod {
		racal::RequestMethod::Post
	}
}

/// Un-bans a user from a Group.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct GroupUnban {
	/// The ID of the group
	pub group_id: crate::id::Group,
	/// The ID of the user to un-ban
	pub user_id: crate::id::User,
}

impl Queryable<Authentication, crate::model::GroupBan> for GroupUnban {
	fn url(&self, _: &Authentication) -> String {
		format!(
			"{}/groups/{}/bans/{}",
			crate::API_BASE_URI,
			self.group_id.as_ref(),
			self.user_id.as_ref()
		)
	}

	fn method(&self, _state: &Authentication) -> racal::RequestMethod {
		racal::RequestMethod::Delete
	}
}

/// Returns a Limited Group Member.
/// Will error without proper permissions, if not a member, etc.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
pub struct GroupMember {
	/// The ID of the group
	pub group_id: crate::id::Group,
	/// The ID of the user
	pub user_id: crate::id::User,
}

impl Queryable<Authentication, Option<crate::model::GroupMember>>
	for GroupMember
{
	fn url(&self, _: &Authentication) -> String {
		format!(
			"{}/groups/{}/members/{}",
			crate::API_BASE_URI,
			self.group_id.as_ref(),
			self.user_id.as_ref()
		)
	}
}