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

use crate::models::payloads::{
    APIAutoModerationAction, APIAutoModerationRule, APIAutoModerationRuleTriggerMetadata,
    AutoModerationRuleEventType, AutoModerationRuleTriggerType,
};
use serde::{Deserialize, Serialize};

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild}
 */
pub type RESTGetAPIAutoModerationRulesResult = Vec<APIAutoModerationRule>;

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule}
 */
pub type RESTGetAPIAutoModerationRuleResult = APIAutoModerationRule;

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RESTPostAPIAutoModerationRuleJSONBody {
    /**
     * The rule name
     */
    pub name: String,
    /**
     * The rule event type
     */
    pub event_type: AutoModerationRuleEventType,
    /**
     * The rule trigger type
     */
    pub trigger_type: AutoModerationRuleTriggerType,
    /**
     * The rule trigger metadata
     *
     * Can be omitted if the trigger type is {@link AutoModerationRuleTriggerType.Spam}
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trigger_metadata: Option<APIAutoModerationRuleTriggerMetadata>,
    /**
     * The actions which will execute when this rule is triggered
     */
    pub actions: Vec<APIAutoModerationAction>,
    /**
     * Whether this rule is enabled
     *
     * @defaultValue `false`
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /**
     * The role ids that shouldn't be affected by this rule (Maximum of 20)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exempt_roles: Option<Vec<String>>,
    /**
     * The channel ids that shouldn't be affected by this rule (Maximum of 50)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exempt_channels: Option<Vec<String>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule}
 */
pub type RESTPostAPIAutoModerationRuleResult = APIAutoModerationRule;

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule}
 */
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)]
pub struct RESTPatchAPIAutoModerationRuleJSONBody {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event_type: Option<AutoModerationRuleEventType>,
    /**
     * The rule trigger metadata
     *
     * Can be omitted if the trigger type is {@link AutoModerationRuleTriggerType.Spam}
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trigger_metadata: Option<APIAutoModerationRuleTriggerMetadata>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub actions: Option<Vec<APIAutoModerationAction>>,
    /**
     * Whether this rule is enabled
     *
     * @defaultValue `false`
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /**
     * The role ids that shouldn't be affected by this rule (Maximum of 20)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exempt_roles: Option<Vec<String>>,
    /**
     * The channel ids that shouldn't be affected by this rule (Maximum of 50)
     */
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exempt_channels: Option<Vec<String>>,
}

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule}
 */
pub type RESTPatchAPIAutoModerationRuleResult = APIAutoModerationRule;

/**
 * @see {@link https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule}
 */
pub type RESTDeleteAPIAutoModerationRuleResult = ();