ruma-federation-api 0.14.0

Types for the endpoints in the Matrix server-server API.
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

//! `PUT /_matrix/federation/*/exchange_third_party_invite/{roomId}`
//!
//! The receiving server will verify the partial `m.room.member` event given in the request body.
//! If valid, the receiving server will issue an invite as per the [Inviting to a room] section
//! before returning a response to this request.
//!
//! [Inviting to a room]: https://spec.matrix.org/v1.18/server-server-api/#inviting-to-a-room

pub mod v1 {
    //! `/v1/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.18/server-server-api/#put_matrixfederationv1exchange_third_party_inviteroomid

    use ruma_common::{
        OwnedRoomId, OwnedUserId,
        api::{request, response},
        metadata,
        serde::Raw,
    };
    use ruma_events::{
        StateEventType,
        room::{
            member::{MembershipState, RoomMemberEventContent, ThirdPartyInvite},
            third_party_invite::RoomThirdPartyInviteEventContent,
        },
    };

    use crate::{authentication::ServerSignatures, thirdparty::bind_callback};

    metadata! {
        method: PUT,
        rate_limited: false,
        authentication: ServerSignatures,
        path: "/_matrix/federation/v1/exchange_third_party_invite/{room_id}",
    }

    /// Request type for the `exchange_invite` endpoint.
    #[request]
    pub struct Request {
        /// The room ID to exchange the third-party invite in.
        #[ruma_api(path)]
        pub room_id: OwnedRoomId,

        /// The event type.
        ///
        /// Must be [`StateEventType::RoomMember`].
        #[serde(rename = "type")]
        pub kind: StateEventType,

        /// The user ID of the user who sent the original invite event.
        pub sender: OwnedUserId,

        /// The user ID of the invited user.
        pub state_key: OwnedUserId,

        /// The content of the invite event.
        ///
        /// It must have a `membership` of `invite` and the `third_party_invite` field must be set.
        pub content: Raw<RoomMemberEventContent>,
    }

    /// Response type for the `exchange_invite` endpoint.
    #[response]
    #[derive(Default)]
    pub struct Response {}

    impl Request {
        /// Creates a new `Request` for a third-party invite exchange.
        pub fn new(
            room_id: OwnedRoomId,
            sender: OwnedUserId,
            state_key: OwnedUserId,
            content: Raw<RoomMemberEventContent>,
        ) -> Self {
            Self { room_id, kind: StateEventType::RoomMember, sender, state_key, content }
        }

        /// Creates a new `Request` for a third-party invite exchange from a `ThirdPartyInvite`.
        ///
        /// Returns an error if the serialization of the event content fails.
        pub fn with_third_party_invite(
            room_id: OwnedRoomId,
            sender: OwnedUserId,
            state_key: OwnedUserId,
            third_party_invite: ThirdPartyInvite,
        ) -> Result<Self, serde_json::Error> {
            let mut content = RoomMemberEventContent::new(MembershipState::Invite);
            content.third_party_invite = Some(third_party_invite);
            let content = Raw::new(&content)?;

            Ok(Self::new(room_id, sender, state_key, content))
        }

        /// Creates a new `Request` for a third-party invite exchange from a `ThirdPartyInvite` in
        /// the [`bind_callback::v1::Request`] and the matching
        /// [`RoomThirdPartyInviteEventContent`].
        ///
        /// Returns an error if the serialization of the event content fails.
        pub fn with_bind_callback_request_and_event(
            bind_callback_invite: bind_callback::v1::ThirdPartyInvite,
            room_third_party_invite_event: &RoomThirdPartyInviteEventContent,
        ) -> Result<Self, serde_json::Error> {
            let third_party_invite = ThirdPartyInvite::new(
                room_third_party_invite_event.display_name.clone(),
                bind_callback_invite.signed,
            );

            Self::with_third_party_invite(
                bind_callback_invite.room_id,
                bind_callback_invite.sender,
                bind_callback_invite.mxid,
                third_party_invite,
            )
        }
    }

    impl Response {
        /// Creates a new `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}