essence 0.3.3

Essential models and database logic for the Adapt chat platform.
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

use crate::Maybe;
use serde::Deserialize;
#[cfg(feature = "client")]
use serde::Serialize;
#[cfg(feature = "openapi")]
use utoipa::{IntoParams, ToSchema};

/// The payload sent to create a new guild.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct CreateGuildPayload {
    /// The name of the guild. Must be between 2 and 100 characters.
    pub name: String,
    /// The description of the guild. Must be between 0 and 1000 characters, or `None` for
    /// no description.
    pub description: Option<String>,
    /// The icon for the guild. Must be a valid URL, or `None` to not set an icon. This should be
    /// a [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme) if provided.
    pub icon: Option<String>,
    /// The banner URL for the guild. Must be a valid URL, or `None` to not set a banner.
    pub banner: Option<String>,
    /// Whether the guild should be public or not. Defaults to `false`.
    #[serde(default)]
    pub public: bool,
}

/// The payload sent to edit a guild.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct EditGuildPayload {
    /// The new name of the guild. Leave empty to keep the current name.
    pub name: Option<String>,
    /// The new description of the guild. Leave empty to keep the current description, and set to
    /// `null` to remove the description.
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<String>))]
    pub description: Maybe<String>,
    /// The new icon of the guild. Leave empty to keep the current icon, and set to `null` to
    /// remove the icon. The icon should be represented as a
    /// [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme).
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<String>, format = "byte"))]
    pub icon: Maybe<String>,
    /// The new banner URL of the guild. Leave empty to keep the current banner, and set to `null`
    /// to remove the banner.
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<String>))]
    pub banner: Maybe<String>,
    /// Whether the guild should be public or not. Leave empty to keep the current setting.
    pub public: Option<bool>,
}

/// The payload sent to delete a guild.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct DeleteGuildPayload {
    /// The password of the user. If this is a bot account, the password is not required and no
    /// body should be sent.
    pub password: String,
}

/// The query parameters used to specify what information to return when fetching a guild.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(IntoParams))]
pub struct GetGuildQuery {
    /// Whether to resolve the guild's channels in the response.
    #[serde(default)]
    pub channels: bool,
    /// Whether to resolve the guild's members in the response.
    #[serde(default)]
    pub members: bool,
    /// Whether to resolve the guild's roles in the response.
    #[serde(default)]
    pub roles: bool,
}