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
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};

use crate::models::payloads::guild::APIGuildMember;
use crate::models::payloads::user::APIUser;

pub use GuildScheduledEventRecurrenceRuleNWeekday as _Deprecated_GuildScheduledEventRecurrenceRuleNWeekday;

/**
 * Types extracted from https://discord.com/developers/docs/resources/guild-scheduled-event
 */

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventBase {
    /**
     * The id of the guild event
     */
    pub id: String,
    /**
     * The guild id which the scheduled event belongs to
     */
    pub guild_id: String,
    /**
     * The id of the user that created the scheduled event
     */
    pub creator_id: Option<Option<String>>,
    /**
     * The name of the scheduled event
     */
    pub name: String,
    /**
     * The description of the scheduled event
     */
    pub description: Option<Option<String>>,
    /**
     * The time the scheduled event will start
     */
    pub scheduled_start_time: String,
    /**
     * The time at which the guild event will end, or `null` if the event does not have a scheduled time to end
     */
    pub scheduled_end_time: Option<String>,
    /**
     * The privacy level of the scheduled event
     */
    pub privacy_level: GuildScheduledEventPrivacyLevel,
    /**
     * The status of the scheduled event
     */
    pub status: GuildScheduledEventStatus,
    /**
     * The type of hosting entity associated with the scheduled event
     */
    pub entity_type: GuildScheduledEventEntityType,
    /**
     * The id of the hosting entity associated with the scheduled event
     */
    pub entity_id: Option<String>,
    /**
     * The user that created the scheduled event
     */
    pub creator: Option<APIUser>,
    /**
     * The number of users subscribed to the scheduled event
     */
    pub user_count: Option<i64>,
    /**
     * The cover image of the scheduled event
     */
    pub image: Option<Option<String>>,
    /**
     * The definition for how often this event should recur
     */
    pub recurrence_rule: Option<Option<APIGuildScheduledEventRecurrenceRule>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure}
 */
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventRecurrenceRule {
    /**
     * Starting time of the recurrence interval
     */
    pub start: String,
    /**
     * Ending time of the recurrence interval
     */
    pub end: Option<String>,
    /**
     * How often the event occurs
     */
    pub frequency: GuildScheduledEventRecurrenceRuleFrequency,
    /**
     * The spacing between the events, defined by `frequency`.
     * For example, `frequency` of {@link GuildScheduledEventRecurrenceRuleFrequency.Weekly} and an `interval` of `2`
     * would be "every-other week"
     */
    pub interval: i64,
    /**
     * Set of specific days within a week for the event to recur on
     */
    pub by_weekday: Option<Vec<GuildScheduledEventRecurrenceRuleWeekday>>,
    /**
     * List of specific days within a specific week (1-5) to recur on
     */
    pub by_n_weekday: Option<Vec<APIGuildScheduledEventRecurrenceRuleNWeekday>>,
    /**
     * Set of specific months to recur on
     */
    pub by_month: Option<Vec<GuildScheduledEventRecurrenceRuleMonth>>,
    /**
     * Set of specific dates within a month to recur on
     */
    pub by_month_day: Option<Vec<i64>>,
    /**
     * Set of days within a year to recur on (1-364)
     */
    pub by_year_day: Option<Vec<i64>>,
    /**
     * The total amount of times that the event is allowed to recur before stopping
     */
    pub count: Option<i64>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventRecurrenceRuleFrequency {
    Yearly = 0,
    Monthly = 1,
    Weekly = 2,
    Daily = 3,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventRecurrenceRuleWeekday {
    Monday = 0,
    Tuesday = 1,
    Wednesday = 2,
    Thursday = 3,
    Friday = 4,
    Saturday = 5,
    Sunday = 6,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventRecurrenceRuleMonth {
    January = 1,
    February = 2,
    March = 3,
    April = 4,
    May = 5,
    June = 6,
    July = 7,
    August = 8,
    September = 9,
    October = 10,
    November = 11,
    December = 12,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure}
 */
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventRecurrenceRuleNWeekday {
    /**
     * The week to reoccur on.
     */
    pub n: u8,
    /**
     * The day within the week to reoccur on
     */
    pub day: GuildScheduledEventRecurrenceRuleWeekday,
}

/**
 * @deprecated Use {@link APIGuildScheduledEventRecurrenceRuleNWeekday} instead
 */
pub type GuildScheduledEventRecurrenceRuleNWeekday = APIGuildScheduledEventRecurrenceRuleNWeekday;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIStageInstanceGuildScheduledEvent {
    /**
     * The id of the guild event
     */
    pub id: String,
    /**
     * The guild id which the scheduled event belongs to
     */
    pub guild_id: String,
    /**
     * The channel id in which the scheduled event will be hosted, or `null` if entity type is `EXTERNAL`
     */
    pub channel_id: String,
    /**
     * The id of the user that created the scheduled event
     */
    pub creator_id: Option<Option<String>>,
    /**
     * The name of the scheduled event
     */
    pub name: String,
    /**
     * The description of the scheduled event
     */
    pub description: Option<Option<String>>,
    /**
     * The time the scheduled event will start
     */
    pub scheduled_start_time: String,
    /**
     * The time at which the guild event will end, or `null` if the event does not have a scheduled time to end
     */
    pub scheduled_end_time: Option<String>,
    /**
     * The privacy level of the scheduled event
     */
    pub privacy_level: GuildScheduledEventPrivacyLevel,
    /**
     * The status of the scheduled event
     */
    pub status: GuildScheduledEventStatus,
    /**
     * The type of hosting entity associated with the scheduled event
     */
    pub entity_type: GuildScheduledEventEntityType,
    /**
     * The id of the hosting entity associated with the scheduled event
     */
    pub entity_id: Option<String>,
    /**
     * The entity metadata for the scheduled event
     */
    pub entity_metadata: Option<()>,
    /**
     * The user that created the scheduled event
     */
    pub creator: Option<APIUser>,
    /**
     * The number of users subscribed to the scheduled event
     */
    pub user_count: Option<i64>,
    /**
     * The cover image of the scheduled event
     */
    pub image: Option<Option<String>>,
    /**
     * The definition for how often this event should recur
     */
    pub recurrence_rule: Option<Option<APIGuildScheduledEventRecurrenceRule>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIVoiceGuildScheduledEvent {
    /**
     * The id of the guild event
     */
    pub id: String,
    /**
     * The guild id which the scheduled event belongs to
     */
    pub guild_id: String,
    /**
     * The channel id in which the scheduled event will be hosted, or `null` if entity type is `EXTERNAL`
     */
    pub channel_id: String,
    /**
     * The id of the user that created the scheduled event
     */
    pub creator_id: Option<Option<String>>,
    /**
     * The name of the scheduled event
     */
    pub name: String,
    /**
     * The description of the scheduled event
     */
    pub description: Option<Option<String>>,
    /**
     * The time the scheduled event will start
     */
    pub scheduled_start_time: String,
    /**
     * The time at which the guild event will end, or `null` if the event does not have a scheduled time to end
     */
    pub scheduled_end_time: Option<String>,
    /**
     * The privacy level of the scheduled event
     */
    pub privacy_level: GuildScheduledEventPrivacyLevel,
    /**
     * The status of the scheduled event
     */
    pub status: GuildScheduledEventStatus,
    /**
     * The type of hosting entity associated with the scheduled event
     */
    pub entity_type: GuildScheduledEventEntityType,
    /**
     * The id of the hosting entity associated with the scheduled event
     */
    pub entity_id: Option<String>,
    /**
     * The entity metadata for the scheduled event
     */
    pub entity_metadata: Option<()>,
    /**
     * The user that created the scheduled event
     */
    pub creator: Option<APIUser>,
    /**
     * The number of users subscribed to the scheduled event
     */
    pub user_count: Option<i64>,
    /**
     * The cover image of the scheduled event
     */
    pub image: Option<Option<String>>,
    /**
     * The definition for how often this event should recur
     */
    pub recurrence_rule: Option<Option<APIGuildScheduledEventRecurrenceRule>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIExternalGuildScheduledEvent {
    /**
     * The id of the guild event
     */
    pub id: String,
    /**
     * The guild id which the scheduled event belongs to
     */
    pub guild_id: String,
    /**
     * The channel id in which the scheduled event will be hosted, or `null` if entity type is `EXTERNAL`
     */
    pub channel_id: Option<()>,
    /**
     * The id of the user that created the scheduled event
     */
    pub creator_id: Option<Option<String>>,
    /**
     * The name of the scheduled event
     */
    pub name: String,
    /**
     * The description of the scheduled event
     */
    pub description: Option<Option<String>>,
    /**
     * The time the scheduled event will start
     */
    pub scheduled_start_time: String,
    /**
     * The time at which the guild event will end, or `null` if the event does not have a scheduled time to end
     */
    pub scheduled_end_time: Option<String>,
    /**
     * The privacy level of the scheduled event
     */
    pub privacy_level: GuildScheduledEventPrivacyLevel,
    /**
     * The status of the scheduled event
     */
    pub status: GuildScheduledEventStatus,
    /**
     * The type of hosting entity associated with the scheduled event
     */
    pub entity_type: GuildScheduledEventEntityType,
    /**
     * The id of the hosting entity associated with the scheduled event
     */
    pub entity_id: Option<String>,
    /**
     * The entity metadata for the scheduled event
     */
    pub entity_metadata: APIGuildScheduledEventEntityMetadataRequired,
    /**
     * The user that created the scheduled event
     */
    pub creator: Option<APIUser>,
    /**
     * The number of users subscribed to the scheduled event
     */
    pub user_count: Option<i64>,
    /**
     * The cover image of the scheduled event
     */
    pub image: Option<Option<String>>,
    /**
     * The definition for how often this event should recur
     */
    pub recurrence_rule: Option<Option<APIGuildScheduledEventRecurrenceRule>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure}
 */
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum APIGuildScheduledEvent {
    APIExternalGuildScheduledEvent(APIExternalGuildScheduledEvent),
    APIStageInstanceGuildScheduledEvent(APIStageInstanceGuildScheduledEvent),
    APIVoiceGuildScheduledEvent(APIVoiceGuildScheduledEvent),
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata}
 */
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventEntityMetadata {
    /**
     * The location of the scheduled event
     */
    pub location: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventEntityMetadataRequired {
    /**
     * The location of the scheduled event
     */
    pub location: String,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventEntityType {
    StageInstance = 1,
    Voice = 2,
    External = 3,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventStatus {
    Scheduled = 1,
    Active = 2,
    Completed = 3,
    Canceled = 4,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level}
 */
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum GuildScheduledEventPrivacyLevel {
    /**
     * The scheduled event is only accessible to guild members
     */
    GuildOnly = 2,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure}
 */
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIGuildScheduledEventUser {
    /**
     * The scheduled event id which the user subscribed to
     */
    pub guild_scheduled_event_id: String,
    /**
     * The user which subscribed to the event
     */
    pub user: APIUser,
    /**
     * The guild member data for this user for the guild which this event belongs to, if any
     */
    pub member: Option<APIGuildMember>,
}