automate 0.4.0

An asynchronous library to interact with Discord API and make bots
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use crate::gateway::*;
use crate::Snowflake;
use std::collections::HashMap;
use serde_json::Value;
use std::ops::BitOr;
use chrono::NaiveDateTime;

/// A Discord Gateway API Payload.
/// Contains the event data and the sequence
/// number used to resume sessions.
#[object(server)]
pub struct Payload<D> {
    pub op: u8,
    pub d: D,
    pub s: Option<i32>,
    pub t: Option<String>,
}

/// Sent by Discord's Gateway API after connection
/// was successfully established. Contains data about
/// bot itself, the guils it is in and the DMs.
#[payload(op = 0, event = "READY", server)]
pub struct ReadyDispatch {
    pub v: u16,
    pub user: User,
    pub private_channels: Vec<PrivateChannel>,
    pub guilds: Vec<UnavailableGuild>,
    pub session_id: String,
    pub shard: Option<[u32; 2]>,
}

#[payload(op = 0, event = "RESUMED", server)]
pub struct ResumedDispatch(Value);

#[payload(op = 0, event = "CHANNEL_CREATE", server)]
pub struct ChannelCreateDispatch(pub Channel);

#[payload(op = 0, event = "CHANNEL_UPDATE", server)]
pub struct ChannelUpdateDispatch(pub Channel);

#[payload(op = 0, event = "CHANNEL_DELETE", server)]
pub struct ChannelDeleteDispatch(pub Channel);

#[payload(op = 0, event = "CHANNEL_PINS_UPDATE", server)]
pub struct ChannelPinsUpdateDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub last_pin_timestamp: Option<String>,
}

#[payload(op = 0, event = "GUILD_CREATE", server)]
pub struct GuildCreateDispatch(pub Guild);

#[payload(op = 0, event = "GUILD_UPDATE", server)]
pub struct GuildUpdateDispatch(pub Guild);

#[payload(op = 0, event = "GUILD_DELETE", server)]
pub struct GuildDeleteDispatch {
    pub id: Snowflake,
    pub unavailable: Option<bool>,
}

#[payload(op = 0, event = "GUILD_BAN_ADD", server)]
pub struct GuildBanAddDispatch {
    pub guild_id: Snowflake,
    pub user: User,
}

#[payload(op = 0, event = "GUILD_BAN_REMOVE", server)]
pub struct GuildBanRemoveDispatch {
    pub guild_id: Snowflake,
    pub user: User,
}

#[payload(op = 0, event = "GUILD_EMOJIS_UPDATE", server)]
pub struct GuildEmojisUpdateDispatch {
    pub guild_id: Snowflake,
    #[serde(deserialize_with = "automate::encode::json::as_hashmap")]
    pub emojis: HashMap<Snowflake, GuildEmoji>,
}

#[payload(op = 0, event = "GUILD_INTEGRATIONS_UPDATE", server)]
pub struct GuildIntegrationsUpdateDispatch {
    pub guild_id: Snowflake,
}

#[payload(op = 0, event = "GUILD_MEMBER_ADD", server)]
pub struct GuildMemberAddDispatch {
    pub guild_id: Snowflake,
    #[serde(flatten)]
    pub member: GuildMember
}

#[payload(op = 0, event = "GUILD_MEMBER_REMOVE", server)]
pub struct GuildMemberRemoveDispatch {
    pub guild_id: Snowflake,
    pub user: User,
}

#[payload(op = 0, event = "GUILD_MEMBER_UPDATE", server)]
pub struct GuildMemberUpdateDispatch {
    pub guild_id: Snowflake,
    pub roles: Vec<Snowflake>,
    pub user: User,
    pub nick: Option<String>,
    #[option_nullable]
    pub premium_since: Option<Option<NaiveDateTime>>
}

/// Sent in response to [RequestGuildMembers](RequestGuildMembers)
#[payload(op = 0, event = "GUILD_MEMBERS_CHUNK", server)]
pub struct GuildMembersChunkDispatch {
    pub guild_id: Snowflake,
    pub members: Vec<GuildMember>,
    pub not_found: Option<Vec<Snowflake>>,
    pub presences: Option<Vec<PresenceUpdate>>,
}

#[payload(op = 0, event = "GUILD_ROLE_CREATE", server)]
pub struct GuildRoleCreateDispatch {
    pub guild_id: Snowflake,
    pub role: Role,
}

#[payload(op = 0, event = "GUILD_ROLE_UPDATE", server)]
pub struct GuildRoleUpdateDispatch {
    pub guild_id: Snowflake,
    pub role: Role,
}

#[payload(op = 0, event = "GUILD_ROLE_DELETE", server)]
pub struct GuildRoleDeleteDispatch {
    pub guild_id: Snowflake,
    pub role_id: Snowflake,
}

#[payload(op = 0, event = "INVITE_CREATE", server)]
pub struct InviteCreateDispatch {
    pub code: String,
    pub guild_id: Snowflake,
    pub channel_id: Snowflake,
    pub inviter: Option<User>,
    pub uses: i32,
    pub max_uses: i32,
    pub max_age: i32,
    pub temporary: bool,
    pub created_at: String,
}

#[payload(op = 0, event = "INVITE_DELETE", server)]
pub struct InviteDeleteDispatch {
    pub code: String,
    pub guild_id: Snowflake,
    pub channel_id: Snowflake,
}

#[payload(op = 0, event = "MESSAGE_CREATE", server)]
pub struct MessageCreateDispatch(pub Message);

#[payload(op = 0, event = "MESSAGE_UPDATE", server)]
pub struct MessageUpdateDispatch(pub PartialMessage);

#[payload(op = 0, event = "MESSAGE_DELETE", server)]
pub struct MessageDeleteDispatch {
    pub id: Snowflake,
    pub channel_id: Snowflake,
    pub guild_id: Option<Snowflake>,
}

#[payload(op = 0, event = "MESSAGE_DELETE_BULK", server)]
pub struct MessageDeleteBulkDispatch {
    pub ids: Vec<Snowflake>,
    pub channel_id: Snowflake,
    pub guild_id: Option<Snowflake>,
}

#[payload(op = 0, event = "MESSAGE_REACTION_ADD", server)]
pub struct MessageReactionAddDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub user_id: Snowflake,
    pub member: Option<GuildMember>,
    pub message_id: Snowflake,
    pub emoji: PartialEmoji,
}

#[payload(op = 0, event = "MESSAGE_REACTION_REMOVE", server)]
pub struct MessageReactionRemoveDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub user_id: Snowflake,
    pub message_id: Snowflake,
    pub emoji: PartialEmoji,
}

#[payload(op = 0, event = "MESSAGE_REACTION_REMOVE_ALL", server)]
pub struct MessageReactionRemoveAllDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub message_id: Snowflake,
}

#[payload(op = 0, event = "MESSAGE_REACTION_REMOVE_EMOJI", server)]
pub struct MessageReactionRemoveEmojiDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub message_id: Snowflake,
    pub emoji: PartialEmoji,
}

/// This payload should not be handled by bots
/// as it will always be empty and does not mean
/// anything.
///
/// More information in [this issue](https://github.com/discordapp/discord-api-docs/issues/683)
#[payload(op = 0, event = "PRESENCES_REPLACE", server)]
pub struct PresencesReplaceDispatch(pub Vec<PresenceUpdate>);

#[payload(op = 0, event = "PRESENCE_UPDATE", server)]
pub struct PresenceUpdateDispatch(pub PresenceUpdate);

#[payload(op = 0, event = "TYPING_START", server)]
pub struct TypingStartDispatch {
    pub guild_id: Option<Snowflake>,
    pub channel_id: Snowflake,
    pub user_id: Snowflake,
    pub timestamp: u32,
    pub member: Option<GuildMember>,
}

#[payload(op = 0, event = "USER_UPDATE", server)]
pub struct UserUpdateDispatch(pub User);

#[payload(op = 0, event = "VOICE_STATE_UPDATE", server)]
pub struct VoiceStateUpdateDispatch(pub VoiceState);

#[payload(op = 0, event = "VOICE_SERVER_UPDATE", server)]
pub struct VoiceServerUpdateDispatch {
    pub token: String,
    pub guild_id: Snowflake,
    pub endpoint: String,
}

#[payload(op = 0, event = "WEBHOOKS_UPDATE", server)]
pub struct WebhooksUpdateDispatch {
    pub guild_id: Snowflake,
    pub channel_id: Snowflake,
}

#[payload(op = 1, client)]
pub struct Heartbeat(pub Option<i32>);

#[payload(op = 2, client)]
pub struct Identify {
    pub token: String,
    pub properties: HashMap<String, String>,
    pub compress: bool,
    pub shard: [u32; 2],
    pub large_threshold: Option<u32>,
    pub presence: Option<UpdateStatus>,
    pub guild_subscriptions: Option<bool>,
    pub intents: Option<u32>,
}

#[payload(op = 3, client)]
pub struct UpdateStatus {
    #[nullable]
    pub since: Option<i32>,
    #[nullable]
    pub game: Option<ActivityUpdate>,
    pub status: StatusType,
    pub afk: bool,
}

#[payload(op = 4, client)]
pub struct UpdateVoiceState {
    pub guild_id: Snowflake,
    #[nullable]
    pub channel_id: Option<Snowflake>,
    pub self_mute: bool,
    pub self_deaf: bool,
}

#[payload(op = 6, client)]
pub struct Resume {
    pub token: String,
    pub session_id: String,
    pub seq: i32,
}

#[payload(op = 7, server)]
pub struct Reconnect;

#[payload(op = 8, client)]
pub struct RequestGuildMembers {
    pub guild_id: Snowflake,
    pub query: Option<String>,
    pub limit: i32,
    pub presences: Option<bool>,
    pub user_ids: Option<Vec<Snowflake>>,
}

#[payload(op = 9, server)]
pub struct InvalidSession(pub bool);

#[payload(op = 10, server)]
pub struct Hello {
    pub heartbeat_interval: u32
}

#[stringify(snake_case)]
pub enum StatusType {
    Online,
    Dnd,
    Idle,
    Invisible,
    Offline,
}

/// System to help define which events discord will
/// send to your bot. An intent is a single or a
/// group of event types.
#[convert(u32)]
pub enum Intent {
    /// Subscribe to the following events:
    ///  - [GuildCreate](automate::gateway::GuildCreateDispatch)
    ///  - [GuildDelete](automate::gateway::GuildDeleteDispatch)
    ///  - [GuildRoleCreate](automate::gateway::GuildRoleCreateDispatch)
    ///  - [GuildRoleUpdate](automate::gateway::GuildRoleUpdateDispatch)
    ///  - [GuildRoleDelete](automate::gateway::GuildRoleDeleteDispatch)
    ///  - [ChannelCreate](automate::gateway::ChannelCreateDispatch)
    ///  - [ChannelUpdate](automate::gateway::ChannelUpdateDispatch)
    ///  - [ChannelDelete](automate::gateway::ChannelDeleteDispatch)
    ///  - [ChannelPinsUpdate](automate::gateway::ChannelPinsUpdateDispatch)
    Guilds = 1 << 0,

    /// Subscribe to the following events:
    ///  - [GuildMemberAdd](automate::gateway::GuildMemberAddDispatch)
     ///  - [GuildMemberUpdate](automate::gateway::GuildMemberUpdateDispatch)
     ///  - [GuildMemberRemove](automate::gateway::GuildMemberRemoveDispatch)
    GuildMembers = 1 << 1,

    /// Subscribe to the following events:
    ///  - [GuildBanAdd](automate::gateway::GuildBanAddDispatch)
    ///  - [GuildBanRemove](automate::gateway::GuildBanRemoveDispatch)
    GuildBans = 1 << 2,

    /// Subscribe to the [GuildEmojisUpdate](automate::gateway::GuildEmojisUpdateDispatch) event.
    GuildEmojis = 1 << 3,

    /// Subscribe to the [GuildIntegrationsUpdate](automate::gateway::GuildIntegrationsUpdateDispatch) event.
    GuildIntegrations = 1 << 4,

    /// Subscribe to the [WebhooksUpdate](automate::gateway::WebhooksUpdateDispatch) event.
    GuildWebhooks = 1 << 5,

    /// Subscribe to the following events:
    ///  - [InviteCreate](automate::gateway::InviteCreateDispatch)
    ///  - [InviteDelete](automate::gateway::InviteDeleteDispatch)
    GuildInvites = 1 << 6,

    /// Subscribe to the [VoiceStateUpdate](automate::gateway::VoiceStateUpdateDispatch) event.
    GuildVoiceStates = 1 << 7,

    /// Subscribe to the [PresenceUpdate](automate::gateway::PresenceUpdateDispatch) event.
    GuildPresences = 1 << 8,

    /// Subscribe to the following events:
    ///  - [MessageCreate](automate::gateway::MessageCreateDispatch)
    ///  - [MessageUpdate](automate::gateway::MessageUpdateDispatch)
    ///  - [MessageDelete](automate::gateway::MessageDeleteDispatch)
    GuildMessages = 1 << 9,

    /// Subscribe to the following events:
    ///  - [MessageReactionAdd](automate::gateway::MessageReactionAddDispatch)
    ///  - [MessageReactionRemove](automate::gateway::MessageReactionRemoveDispatch)
    ///  - [MessageReactionRemoveAll](automate::gateway::MessageReactionRemoveAllDispatch)
    ///  - [MessageReactionRemoveEmoji](automate::gateway::MessageReactionRemoveEmojiDispatch)
    GuildMessageReactions = 1 << 10,

    /// Subscribe to the [TypingStart](automate::gateway::TypingStartDispatch) event.
    GuildMessageTyping = 1 << 11,

    /// Subscribe to the following events:
    ///  - [ChannelCreate](automate::gateway::ChannelCreateDispatch)
    ///  - [MessageCreate](automate::gateway::MessageCreateDispatch)
    ///  - [MessageUpdate](automate::gateway::MessageUpdateDispatch)
    ///  - [MessageDelete](automate::gateway::MessageDeleteDispatch)
    ///  - [ChannelPinsUpdate](automate::gateway::ChannelPinsUpdateDispatch)
    DirectMessages = 1 << 12,

    /// Subscribe to the following events:
    ///  - [MessageReactionAdd](automate::gateway::MessageReactionAddDispatch)
    ///  - [MessageReactionRemove](automate::gateway::MessageReactionRemoveDispatch)
    ///  - [MessageReactionRemoveAll](automate::gateway::MessageReactionRemoveAllDispatch)
    ///  - [MessageReactionRemoveEmoji](automate::gateway::MessageReactionRemoveEmojiDispatch)
    DirectMessageReactions = 1 << 13,

    /// Subscribe to the [TypingStart](automate::gateway::TypingStartDispatch) event.
    DirectMessageTyping = 1 << 14,
}

impl BitOr for Intent {
    type Output = u32;

    fn bitor(self, rhs: Self) -> u32 {
        self as u32 | rhs as u32
    }
}

impl BitOr<u32> for Intent {
    type Output = u32;

    fn bitor(self, rhs: u32) -> u32 {
        self as u32 | rhs
    }
}