palpo-core 0.0.2

Core library used by the palpo crates.
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

//! `GET /_matrix/client/*/notifications`
//!
//! Paginate through the list of events that the user has been, or would have been notified about.
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3notifications
use salvo::prelude::*;
use serde::{Deserialize, Serialize};

use crate::events::AnySyncTimelineEvent;
use crate::push::Action;
use crate::serde::RawJson;
use crate::{OwnedRoomId, UnixMillis};

// const METADATA: Metadata = metadata! {
//     method: GET,
//     rate_limited: false,
//     authentication: AccessToken,
//     history: {
//         1.0 => "/_matrix/client/r0/notifications",
//         1.1 => "/_matrix/client/v3/notifications",
//     }
// };

#[derive(ToSchema, Default, Serialize, Deserialize)]
pub struct NotificationsReqBody {
    /// Pagination token given to retrieve the next set of events.
    #[salvo(parameter(parameter_in = Query))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub from: Option<String>,

    /// Limit on the number of events to return in this request.
    #[salvo(parameter(parameter_in = Query))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<usize>,

    /// Allows basic filtering of events returned.
    ///
    /// Supply "highlight" to return only events where the notification had the 'highlight'
    /// tweak set.
    #[salvo(parameter(parameter_in = Query))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub only: Option<String>,
}

// /// Request type for the `get_notifications` endpoint.

// #[derive(Default)]
// pub struct NotificationsReqBody {
//     /// Pagination token given to retrieve the next set of events.
//     #[salvo(parameter(parameter_in = Query))]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub from: Option<String>,

//     /// Limit on the number of events to return in this request.
//     #[salvo(parameter(parameter_in = Query))]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub limit: Option<usize>,

//     /// Allows basic filtering of events returned.
//     ///
//     /// Supply "highlight" to return only events where the notification had the 'highlight'
//     /// tweak set.
//     #[salvo(parameter(parameter_in = Query))]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub only: Option<String>,
// }

/// Response type for the `get_notifications` endpoint.
#[derive(ToSchema, Serialize, Debug)]
pub struct NotificationsResBody {
    /// The token to supply in the from param of the next /notifications request in order to
    /// request more events.
    ///
    /// If this is absent, there are no more results.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub next_token: Option<String>,

    /// The list of events that triggered notifications.
    pub notifications: Vec<Notification>,
}
impl NotificationsResBody {
    /// Creates a new `Response` with the given notifications.
    pub fn new(notifications: Vec<Notification>) -> Self {
        Self {
            next_token: None,
            notifications,
        }
    }
}

/// Represents a notification.
#[derive(ToSchema, Deserialize, Serialize, Clone, Debug)]
pub struct Notification {
    /// The actions to perform when the conditions for this rule are met.
    pub actions: Vec<Action>,

    /// The event that triggered the notification.
    pub event: RawJson<AnySyncTimelineEvent>,

    /// The profile tag of the rule that matched this event.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub profile_tag: Option<String>,

    /// Indicates whether the user has sent a read receipt indicating that they have read this
    /// message.
    pub read: bool,

    /// The ID of the room in which the event was posted.
    pub room_id: OwnedRoomId,

    /// The time at which the event notification was sent.
    pub ts: UnixMillis,
}