voiceflousion 0.3.1

A crate that provides toolkit for Voiceflow AI bots integrations and pre-built functionality for quick integration with popular messengers
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

use serde::Serialize;
use serde_json::Value;
use crate::core::voiceflow::request_structures::ActionType;
use crate::core::voiceflow::request_structures::payload::Payload;

/// Represents an action to be performed in the Voiceflow API.
///
/// `Action` contains the type of action and an optional payload associated with the action.
#[derive(Debug, Serialize)]
pub(crate) struct Action {
    /// The type of action to be performed.
    #[serde(rename = "type")]
    action_type: ActionType,

    /// The optional payload associated with the action.
    #[serde(skip_serializing_if = "Option::is_none")]
    payload: Option<Payload>,
}

/// A builder for creating an `Action`.
///
/// `ActionBuilder` allows for the incremental construction of an `Action` by setting various fields.
pub(crate) struct ActionBuilder {
    action_type: ActionType,
    payload: Option<Payload>,
}

impl ActionBuilder {
    /// Creates a new `ActionBuilder` with the specified action type.
    ///
    /// # Parameters
    ///
    /// * `action_type` - The type of action to be performed.
    ///
    /// # Returns
    ///
    /// A new instance of `ActionBuilder`.
    pub fn new(action_type: ActionType) -> Self {
        Self {
            action_type,
            payload: None,
        }
    }

    /// Sets the text payload for the `Action`.
    ///
    /// # Parameters
    ///
    /// * `text` - The text to be included in the payload.
    ///
    /// # Returns
    ///
    /// The `ActionBuilder` with the text payload set.
    pub fn text(mut self, text: String) -> Self {
        let json_value: Value = Value::String(text);
        self.payload = Some(Payload::Single(json_value));
        self
    }

    /// Sets the intent payload for the `Action`.
    ///
    /// # Parameters
    ///
    /// * `name` - The name of the intent.
    /// * `path` - The path associated with the intent.
    ///
    /// # Returns
    ///
    /// The `ActionBuilder` with the intent payload set.
    pub fn intent(mut self, name: String, path: String) -> Self {
        let json_value: Value = serde_json::json!({
            "query": name,
            "intent":{
                "name": path
            }
        });
        self.payload = Some(Payload::Object(json_value));
        self
    }
    /// Sets the path payload for the `Action`.
    ///
    /// # Parameters
    ///
    /// * `payload` - The payload to be included in the path payload.
    ///
    /// # Returns
    ///
    /// The `ActionBuilder` with the path payload set.
    pub fn path(mut self, payload: Value) -> Self{
        self.payload = Some(Payload::Object(payload));
        self
    }

    /// Builds the `Action`.
    ///
    /// # Returns
    ///
    /// A new instance of `Action` with the configured fields.
    pub fn build(self) -> Action {
        Action {
            action_type: self.action_type,
            payload: self.payload,
        }
    }
}