russenger 0.3.1

A Rust library designed to simplify the handling of Facebook Messenger webhook responses.
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

//! This module provides a `GetStartedModel` struct that represents the GET STARTED button in a Messenger conversation.
//!
//! ## GetStartedModel Struct
//!
//! The `GetStartedModel` struct represents the GET STARTED button in a Messenger conversation. This button is shown when the user talks to the bot for the first time.
//!
//! ### Fields
//!
//! * `get_started: String` - The payload of the GET STARTED button.
//!
//! ### Methods
//!
//! * `new(payload: Payload) -> Self` - Creates a new `GetStartedModel` instance.
//!
//! ## Examples
//!
//! Creating a `GetStartedModel` and sending it:
//!
//! ```rust
//! use russenger::prelude::*;
//!
//! async fn index(res: Res, req: Req) -> Result<()> {
//!     res.send(GetStartedButtonModel::new(Payload::default())).await?;
//!
//!     Ok(())
//! }
//! ```
//!
//! ## Returns
//!
//! A POST request to the Facebook API to send a media file using the Facebook URL.
//!
//! ## Reference
//!
//! [Facebook Messenger Platform - Get Started Button](https://developers.facebook.com/docs/messenger-platform/reference/messenger-profile-api/get-started-button)
use serde::Serialize;

use super::{payload::Payload, ResponseModel};

/// `GetStartedModel` is a struct that represents the GET STARTED button in a Messenger conversation.
///
/// This button is shown when the user talks to the bot for the first time.
///
/// # Fields
///
/// * `get_started: String` - The payload of the GET STARTED button.
///
/// # Methods
///
/// * `new(payload: Payload) -> Self` - Creates a new `GetStartedModel` instance.
///
/// # Examples
///
/// Creating a `GetStartedModel` and sending it:
///
/// ```rust
/// use russenger::prelude::*;
///
/// async fn index(res: Res, req: Req) -> Result<()>{
///     res.send(GetStartedButtonModel::new(Payload::default())).await?;
///
///     Ok(())
/// }
/// ```
///
/// # Returns
///
/// A POST request to the Facebook API to send a media file using the Facebook URL.
///
/// # Reference
///
/// [Facebook Messenger Platform - Get Started Button](https://developers.facebook.com/docs/messenger-platform/reference/messenger-profile-api/get-started-button)
#[derive(Debug, Clone, Serialize)]
pub struct GetStartedButtonModel {
    get_started: serde_json::Value,
}

impl GetStartedButtonModel {
    /// Creates a new `GetStartedModel` instance.
    ///
    /// # Parameters
    ///
    /// * `payload: Payload` - The payload of the GET STARTED button.
    ///
    /// # Returns
    ///
    /// A new `GetStartedModel` instance.
    ///
    /// # Example
    ///
    /// ```rust
    /// use russenger::response_models::get_started::GetStartedButtonModel;
    /// use russenger::response_models::payload::Payload;
    ///
    /// GetStartedButtonModel::new(Payload::default());
    /// ```
    pub fn new(payload: Payload) -> Self {
        Self {
            get_started: serde_json::json!({"payload": payload}),
        }
    }
}

impl ResponseModel for GetStartedButtonModel {
    const END_POINT: &'static str = "messenger_profile";
}