discord-ferris 0.0.2

discord-ferris is a Discord API Rust library under development 🦀
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

use crate::models::payloads::{
    APIApplicationRoleConnection, APIChannel, APIConnection, APIGuildMember, APIUser, GuildFeature,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
 */
pub type RESTGetAPICurrentUserResult = APIUser;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-user}
 */
pub type RESTGetAPIUserResult = APIUser;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
 */
pub type RESTGetCurrentUserGuildMemberResult = APIGuildMember;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#modify-current-user}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct RESTPatchAPICurrentUserJSONBody {
    /**
     * User's username, if changed may cause the user's discriminator to be randomized
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub username: Option<String>,
    /**
     * If passed, modifies the user's avatar
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub avatar: Option<Option<String>>,
    /**
     * If passed, modifies the user's banner
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub banner: Option<Option<String>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/user#modify-current-user}
 */
pub type RESTPatchAPICurrentUserResult = APIUser;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct RESTGetAPICurrentUserGuildsQuery {
    /**
     * Get guilds before this guild ID
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<String>,
    /**
     * Get guilds after this guild ID
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /**
     * Max number of guilds to return (1-200)
     *
     * @defaultValue `200`
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u16>,
    /**
     * Include approximate member and presence counts in response
     *
     * @defaultValue `false`
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub with_counts: Option<bool>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct RESTAPIPartialCurrentUserGuild {
    pub id: String,
    pub name: String,
    pub icon: Option<String>,
    pub banner: Option<String>,
    pub owner: bool,
    pub features: Vec<GuildFeature>,
    pub permissions: String,
    pub approximate_member_count: Option<u64>,
    pub approximate_presence_count: Option<u64>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
 */
pub type RESTGetAPICurrentUserGuildsResult = Vec<RESTAPIPartialCurrentUserGuild>;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#leave-guild}
 */
pub type RESTDeleteAPICurrentUserGuildResult = ();

/**
 * @see {@link https://discord.com/developers/docs/resources/user#create-dm}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct RESTPostAPICurrentUserCreateDMChannelJSONBody {
    /**
     * The recipient to open a DM channel with
     */
    pub recipient_id: String,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/user#create-dm}
 */
pub type RESTPostAPICurrentUserCreateDMChannelResult = APIChannel;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
 */
pub type RESTGetAPICurrentUserConnectionsResult = Vec<APIConnection>;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#get-user-application-role-connection}
 */
pub type RESTGetAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;

/**
 * @see {@link https://discord.com/developers/docs/resources/user#update-user-application-role-connection}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct RESTPutAPICurrentUserApplicationRoleConnectionJSONBody {
    /**
     * The vanity name of the platform a bot has connected (max 50 characters)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub platform_name: Option<String>,
    /**
     * The username on the platform a bot has connected (max 100 characters)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub platform_username: Option<String>,
    /**
     * Object mapping application role connection metadata keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<HashMap<String, Value>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/user#update-user-application-role-connection}
 */
pub type RESTPutAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;