lib-client-slack 0.1.0

Slack API client library for ADI
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

use serde::Serialize;

/// Block Kit block.
#[derive(Debug, Clone, Serialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum Block {
    Section(SectionBlock),
    Divider,
    Header(HeaderBlock),
    Context(ContextBlock),
    Actions(ActionsBlock),
    Image(ImageBlock),
}

/// Section block.
#[derive(Debug, Clone, Serialize)]
pub struct SectionBlock {
    pub text: TextObject,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accessory: Option<BlockElement>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fields: Option<Vec<TextObject>>,
}

/// Header block.
#[derive(Debug, Clone, Serialize)]
pub struct HeaderBlock {
    pub text: TextObject,
}

/// Context block.
#[derive(Debug, Clone, Serialize)]
pub struct ContextBlock {
    pub elements: Vec<ContextElement>,
}

/// Actions block.
#[derive(Debug, Clone, Serialize)]
pub struct ActionsBlock {
    pub elements: Vec<BlockElement>,
}

/// Image block.
#[derive(Debug, Clone, Serialize)]
pub struct ImageBlock {
    pub image_url: String,
    pub alt_text: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<TextObject>,
}

/// Text object.
#[derive(Debug, Clone, Serialize)]
pub struct TextObject {
    #[serde(rename = "type")]
    pub text_type: TextType,
    pub text: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub emoji: Option<bool>,
}

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum TextType {
    PlainText,
    Mrkdwn,
}

impl TextObject {
    pub fn plain(text: impl Into<String>) -> Self {
        Self {
            text_type: TextType::PlainText,
            text: text.into(),
            emoji: Some(true),
        }
    }

    pub fn mrkdwn(text: impl Into<String>) -> Self {
        Self {
            text_type: TextType::Mrkdwn,
            text: text.into(),
            emoji: None,
        }
    }
}

/// Context element.
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum ContextElement {
    Text(TextObject),
    Image { type_: String, image_url: String, alt_text: String },
}

/// Block element.
#[derive(Debug, Clone, Serialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum BlockElement {
    Button(ButtonElement),
    StaticSelect(StaticSelectElement),
    Overflow(OverflowElement),
}

/// Button element.
#[derive(Debug, Clone, Serialize)]
pub struct ButtonElement {
    pub text: TextObject,
    pub action_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub style: Option<ButtonStyle>,
}

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum ButtonStyle {
    Primary,
    Danger,
}

/// Static select element.
#[derive(Debug, Clone, Serialize)]
pub struct StaticSelectElement {
    pub placeholder: TextObject,
    pub action_id: String,
    pub options: Vec<SelectOption>,
}

/// Select option.
#[derive(Debug, Clone, Serialize)]
pub struct SelectOption {
    pub text: TextObject,
    pub value: String,
}

/// Overflow element.
#[derive(Debug, Clone, Serialize)]
pub struct OverflowElement {
    pub action_id: String,
    pub options: Vec<SelectOption>,
}

// Builder helpers
impl Block {
    pub fn section(text: TextObject) -> Self {
        Self::Section(SectionBlock {
            text,
            accessory: None,
            fields: None,
        })
    }

    pub fn divider() -> Self {
        Self::Divider
    }

    pub fn header(text: impl Into<String>) -> Self {
        Self::Header(HeaderBlock {
            text: TextObject::plain(text),
        })
    }

    pub fn context(elements: Vec<ContextElement>) -> Self {
        Self::Context(ContextBlock { elements })
    }
}