slack_messaging/composition_objects/
workflow.rs

1use crate::composition_objects::Trigger;
2use crate::validators::required;
3
4use serde::Serialize;
5use slack_messaging_derive::Builder;
6
7/// [Workflow object](https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object)
8/// representation.
9///
10/// # Fields and Validations
11///
12/// For more details, see the [official
13/// documentation](https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object).
14///
15/// | Field | Type | Required | Validation |
16/// |-------|------|----------|------------|
17/// | trigger | [Trigger] | Yes | N/A |
18///
19/// # Example
20///
21/// ```
22/// use slack_messaging::composition_objects::{types::InputParameter, Trigger, Workflow};
23/// # use std::error::Error;
24///
25/// # fn try_main() -> Result<(), Box<dyn Error>> {
26/// let workflow = Workflow::builder()
27///     .trigger(
28///         Trigger::builder()
29///              .url("https://slack.com/shortcuts/Ft0123ABC456/123...xyz")
30///              .customizable_input_parameter(
31///                  InputParameter::builder()
32///                      .name("input_parameter_a")
33///                      .value("Value for input param A")
34///                      .build()?
35///              )
36///              .customizable_input_parameter(
37///                  InputParameter::builder()
38///                      .name("input_parameter_b")
39///                      .value("Value for input param B")
40///                      .build()?
41///              )
42///              .build()?
43///     )
44///     .build()?;
45///
46/// let expected = serde_json::json!({
47///     "trigger": {
48///         "url": "https://slack.com/shortcuts/Ft0123ABC456/123...xyz",
49///         "customizable_input_parameters": [
50///             {
51///                 "name": "input_parameter_a",
52///                 "value": "Value for input param A"
53///             },
54///             {
55///                 "name": "input_parameter_b",
56///                 "value": "Value for input param B"
57///             }
58///         ]
59///     }
60/// });
61///
62/// let json = serde_json::to_value(workflow).unwrap();
63///
64/// assert_eq!(json, expected);
65///
66/// // If your object has any validation errors, the build method returns Result::Err
67/// let workflow = Workflow::builder().build();
68/// assert!(workflow.is_err());
69/// #     Ok(())
70/// # }
71/// # fn main() {
72/// #     try_main().unwrap()
73/// # }
74/// ```
75#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
76pub struct Workflow {
77    #[builder(validate("required"))]
78    pub(crate) trigger: Option<Trigger>,
79}
80
81#[cfg(test)]
82mod tests {
83    use super::*;
84    use crate::composition_objects::test_helpers::*;
85    use crate::errors::*;
86
87    #[test]
88    fn it_implements_builder() {
89        let expected = Workflow {
90            trigger: Some(trigger()),
91        };
92
93        let val = Workflow::builder()
94            .set_trigger(Some(trigger()))
95            .build()
96            .unwrap();
97
98        assert_eq!(val, expected);
99
100        let val = Workflow::builder().trigger(trigger()).build().unwrap();
101
102        assert_eq!(val, expected);
103    }
104
105    #[test]
106    fn it_requires_trigger_field() {
107        let err = Workflow::builder().build().unwrap_err();
108        assert_eq!(err.object(), "Workflow");
109
110        let errors = err.field("trigger");
111        assert!(errors.includes(ValidationErrorKind::Required));
112    }
113}
slack_messaging/composition_objects/workflow.rs

slack_messaging/composition_objects/
workflow.rs
