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

use crate::models::payloads::base::{
    APIBaseInteraction, APIDMInteractionWrapper, APIGuildInteractionWrapper,
    APIInteractionDataResolved, APIUserInteractionDataResolved,
};
use crate::models::payloads::channel::ComponentType;
use crate::models::payloads::responses::InteractionType;

use serde::{Deserialize, Serialize};

/**
 * The base interaction for message components with strongly-typed `data`.
 */
pub type APIMessageComponentInteraction =
    APIBaseInteraction<InteractionType, APIMessageComponentInteractionData>;

/**
 * Specialized interaction where the component is a button.
 */
pub type APIMessageComponentButtonInteraction =
    APIBaseInteraction<InteractionType, APIMessageButtonInteractionData>;

/**
 * Specialized interaction where the component is any select menu.
 */
pub type APIMessageComponentSelectMenuInteraction =
    APIBaseInteraction<InteractionType, APIMessageSelectMenuInteractionData>;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum APIMessageComponentInteractionData {
    APIMessageButtonInteractionData(APIMessageButtonInteractionData),
    APIMessageSelectMenuInteractionData(APIMessageSelectMenuInteractionData),
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageComponentBaseInteractionData {
    /**
     * The `custom_id` of the component
     */
    pub custom_id: String,
    /**
     * The type of the component
     */
    pub component_type: ComponentType,
}

/**
 * Button component interaction payload.
 */
pub type APIMessageButtonInteractionData = APIMessageComponentBaseInteractionData;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageStringSelectInteractionData {
    #[serde(flatten)]
    pub base: APIMessageComponentBaseInteractionData,
    pub values: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageUserSelectInteractionData {
    #[serde(flatten)]
    pub base: APIMessageComponentBaseInteractionData,
    pub values: Vec<String>,
    pub resolved: APIUserInteractionDataResolved,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageRoleSelectInteractionData {
    #[serde(flatten)]
    pub base: APIMessageComponentBaseInteractionData,
    pub values: Vec<String>,
    /**
     * Uses the resolved structure where `roles` is expected to be present.
     */
    pub resolved: APIInteractionDataResolved,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageMentionableSelectInteractionData {
    #[serde(flatten)]
    pub base: APIMessageComponentBaseInteractionData,
    pub values: Vec<String>,
    /**
     * Uses the resolved structure, typically including `members`, `roles`, and `users`.
     */
    pub resolved: APIInteractionDataResolved,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct APIMessageChannelSelectInteractionData {
    #[serde(flatten)]
    pub base: APIMessageComponentBaseInteractionData,
    pub values: Vec<String>,
    /**
     * Uses the resolved structure where `channels` is expected to be present.
     */
    pub resolved: APIInteractionDataResolved,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum APIMessageSelectMenuInteractionData {
    APIMessageChannelSelectInteractionData(APIMessageChannelSelectInteractionData),
    APIMessageMentionableSelectInteractionData(APIMessageMentionableSelectInteractionData),
    APIMessageRoleSelectInteractionData(APIMessageRoleSelectInteractionData),
    APIMessageStringSelectInteractionData(APIMessageStringSelectInteractionData),
    APIMessageUserSelectInteractionData(APIMessageUserSelectInteractionData),
}

pub type APIMessageComponentDMInteraction = APIDMInteractionWrapper<APIMessageComponentInteraction>;

pub type APIMessageComponentGuildInteraction =
    APIGuildInteractionWrapper<APIMessageComponentInteraction>;